This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
The following commit(s) were added to refs/heads/master by this push:
new be2b8003a Port from Doxia 1 to 2
be2b8003a is described below
commit be2b8003ad05b4db5d0425f86f1d5d4d1c258b3e
Author: Gary D. Gregory <[email protected]>
AuthorDate: Thu Jan 23 15:09:34 2025 -0500
Port from Doxia 1 to 2
---
src/site/site.xml | 59 ++++++++++++++++++++++++++++++-------------
src/site/xdoc/conventions.xml | 8 +++---
src/site/xdoc/examples.xml | 15 ++++++-----
src/site/xdoc/index.xml | 4 ++-
src/site/xdoc/limitations.xml | 13 ++++++----
src/site/xdoc/pack200.xml | 4 ++-
src/site/xdoc/security.xml | 4 ++-
src/site/xdoc/tar.xml | 4 ++-
src/site/xdoc/zip.xml | 8 ++++--
9 files changed, 82 insertions(+), 37 deletions(-)
diff --git a/src/site/site.xml b/src/site/site.xml
index 894f3ea73..2fe7b07cc 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -17,29 +17,54 @@
limitations under the License.
-->
-<project name="Commons Compress">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
- <bannerRight>
- <name>Commons Compress</name>
- <src>/images/compress-logo-white.png</src>
- <href>/index.html</href>
- </bannerRight>
+ https://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";
+ name="Apache Commons BCEL">
+ <bannerRight name="Commons BCEL" href="/index.html">
+ <image src="/images/logo.png"/>
+ </bannerRight>
<body>
- <menu name="Compress">
- <item name="Overview" href="/index.html"/>
+ <menu name="Commons BCEL">
+ <!-- Start: For all components. -->
+ <item name="About" href="index.html" />
+ <item name="Asking Questions" href="/mail-lists.html" />
+ <item name="Release History" href="/changes.html" />
+ <item name="Issue Tracking" href="/issue-management.html" />
+ <item name="Dependency Management" href="/dependency-info.html" />
+ <item name="Sources" href="/scm.html" />
+ <item name="Security" href="security.html" />
+ <item name="License" href="https://www.apache.org/licenses/LICENSE-2.0";
/>
+ <item name="Code of Conduct"
href="https://www.apache.org/foundation/policies/conduct.html"; />
+ <item name="Download"
href="https://commons.apache.org/proper/commons-bcel/download_compress.cgi"; />
+ <item name="Javadoc">
+ <item name="Javadoc Current" href="apidocs/index.html" />
+ <item name="Javadoc Archive"
href="https://javadoc.io/doc/org.apache.commons/commons-compress/"; />
+ </item>
+ <!-- End: For all components. -->
+ <!-- Specific to this component: -->
<item name="User Guide" href="/examples.html"/>
<item name="Known Limitations" href="/limitations.html"/>
<item name="Conventions" href="/conventions.html"/>
- <item name="Issue Tracking" href="/issue-tracking.html"/>
- <item name="Download" href="/download_compress.cgi"/>
- <item name="Security" href="/security.html"/>
<item name="Wiki" href="https://wiki.apache.org/commons/Compress"/>
</menu>
- <menu name="API Docs">
- <item name="Javadoc" href="apidocs/index.html"/>
- <item name="Javadoc Archive"
href="https://javadoc.io/doc/org.apache.commons/commons-compress/"/>
- </menu>
</body>
-
-</project>
+</site>
diff --git a/src/site/xdoc/conventions.xml b/src/site/xdoc/conventions.xml
index 59ec3c57e..6fd293602 100644
--- a/src/site/xdoc/conventions.xml
+++ b/src/site/xdoc/conventions.xml
@@ -15,7 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Conventions</title>
</properties>
@@ -36,14 +38,14 @@
We use some of the annotations from
<a
href="http://jcip.net/annotations/doc/net/jcip/annotations/package-summary.html";>JCIP</a>
as Javadoc tags. The used tags are:
-
+ </p>
<ul>
<li>@GuardedBy (field or method)</li>
<li>@Immutable (class)</li>
<li>@NotThreadSafe (class)</li>
<li>@ThreadSafe (class)</li>
</ul>
-
+ <p>
For example:
<source>
/**
diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml
index cba989804..41dbc921c 100644
--- a/src/site/xdoc/examples.xml
+++ b/src/site/xdoc/examples.xml
@@ -17,7 +17,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Commons Compress User Guide</title>
<author email="[email protected]">Commons Documentation Team</author>
@@ -381,7 +383,7 @@ SevenZArchiveEntry entry = sevenZFile.getNextEntry();
sevenZFile.read(); // read current entry's data
]]></source>
- <h4><a name="Encrypted 7z Archives"></a>Encrypted 7z Archives</h4>
+ <h4><a name="Encrypted-7z-Archives"></a>Encrypted 7z Archives</h4>
<p>Currently Compress supports reading but not writing of
encrypted archives. When reading an encrypted archive a
@@ -421,7 +423,7 @@ LOOP UNTIL entry.getSize() HAS BEEN READ {
}
]]></source>
- <h4><a name="Random-Access to 7z Archives"></a>Random-Access to 7z
Archives</h4>
+ <h4><a name="Random-Access-to-7z-Archives"></a>Random-Access to 7z
Archives</h4>
<p>Prior to Compress 1.20 7z archives could only be read
sequentially. The
@@ -431,7 +433,7 @@ LOOP UNTIL entry.getSize() HAS BEEN READ {
will likely be significantly slower than sequential
access.</p>
- <h4><a name="Recovering from Certain Broken 7z
Archives"></a>Recovering from Certain Broken 7z Archives</h4>
+ <h4><a
name="Recovering-from-Certain-Broken-7z-Archives"></a>Recovering from Certain
Broken 7z Archives</h4>
<p><code>SevenZFile</code> tries
to recover archives that look as if they were part of a
@@ -724,8 +726,9 @@ inputStream.read() // read data from the input stream
]]></source>
<p>Creating a zip file with multiple threads:</p>
-
- A simple implementation to create a zip file might look like this:
+ <p>
+ A simple implementation to create a zip file might look like this:
+ </p>
<source><![CDATA[
public class ScatterSample {
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index bd8ed0c9b..df5d31b4d 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -17,7 +17,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Overview</title>
<author email="[email protected]">Commons Documentation
Team</author>
diff --git a/src/site/xdoc/limitations.xml b/src/site/xdoc/limitations.xml
index 92d40ca93..6ceddd348 100644
--- a/src/site/xdoc/limitations.xml
+++ b/src/site/xdoc/limitations.xml
@@ -15,17 +15,20 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Known Limitations and Problems</title>
</properties>
<body>
- <p>This page lists the known limitations and problems of Apache
- Commons Compress™ grouped by the archiving/compression
- format they apply to.</p>
-
<section name="General">
+ <p>
+ This page lists the known limitations and problems of Apache
+ Commons Compress™ grouped by the archiving/compression
+ format they apply to.
+ </p>
<ul>
<li>Several implementations of decompressors and unarchivers will
invoke <a
diff --git a/src/site/xdoc/pack200.xml b/src/site/xdoc/pack200.xml
index 2861caa53..6beb48477 100644
--- a/src/site/xdoc/pack200.xml
+++ b/src/site/xdoc/pack200.xml
@@ -17,7 +17,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Commons Compress Pack200 Package</title>
<author email="[email protected]">Commons Documentation Team</author>
diff --git a/src/site/xdoc/security.xml b/src/site/xdoc/security.xml
index e8af32e7b..0d76c4b53 100644
--- a/src/site/xdoc/security.xml
+++ b/src/site/xdoc/security.xml
@@ -16,7 +16,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Commons Compress Security Reports</title>
<author email="[email protected]">Commons Team</author>
diff --git a/src/site/xdoc/tar.xml b/src/site/xdoc/tar.xml
index 3a3210d38..4bec0c420 100644
--- a/src/site/xdoc/tar.xml
+++ b/src/site/xdoc/tar.xml
@@ -17,7 +17,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Commons Compress TAR package</title>
<author email="[email protected]">Commons Documentation Team</author>
diff --git a/src/site/xdoc/zip.xml b/src/site/xdoc/zip.xml
index a20435f99..ee2bdd9ba 100644
--- a/src/site/xdoc/zip.xml
+++ b/src/site/xdoc/zip.xml
@@ -17,7 +17,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Commons Compress ZIP package</title>
<author email="[email protected]">Commons Documentation Team</author>
@@ -628,7 +630,9 @@
<p>Starting with version 1.19, entries order is kept, then this
specific handling of directories is not
necessary any more.</p>
- See the examples section for a code sample demonstrating how to make
a zip file.
+ <p>
+ See the examples section for a code sample demonstrating how to
make a zip file.
+ </p>
</subsection>
</section>
