Normalize main menu on the website

Use XML Schema to validate XML site templates
apache · Jan 21, 2025 · cf4a1e1 · cf4a1e1
1 parent 924c2b2
commit cf4a1e1
Show file tree

Hide file tree

Showing 17 changed files with 80 additions and 52 deletions.
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -15,15 +15,15 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-<project name="Collections">
-    <bannerRight>
-        <name>Commons Collections</name>
-        <src>/images/logo.png</src>
-        <href>/index.html</href>
-    </bannerRight>
-
-    <body>
-        <head>&lt;script type="text/javascript" id="MathJax-script" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-AMS-MML_HTMLorMML"&gt;&lt;/script&gt;
+<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 http://maven.apache.org/xsd/site-2.0.0.xsd"
+  name="Apache Commons Collections">
+  <bannerRight name="Commons Collections" href="/index.html">
+    <image src="/images/logo.png"/>
+  </bannerRight>
+  <body>
+    <head>&lt;script type="text/javascript" id="MathJax-script" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-AMS-MML_HTMLorMML"&gt;&lt;/script&gt;
         &lt;style&gt;
             .footnotes ol li p {
             display: inline;
@@ -42,23 +42,25 @@
             }
 
             &lt;/style&gt;
-        </head>
-        <menu name="Commons Collections">
-            <item name="Overview" href="/index.html" />
-            <item name="Download" href="/download_collections.cgi" />
-            <item name="User Guide" href="/userguide.html" />
-            <item name="Javadoc" href="/apidocs/index.html" />
-            <item name="Javadoc Archive"
-                href="https://javadoc.io/doc/org.apache.commons/commons-collections4/latest/index.html" />
-        </menu>
-
-        <menu name="Development">
-            <item name="History" href="/changes.html" />
-            <item name="Mailing Lists" href="/mail-lists.html" />
-            <item name="Issue Tracking" href="/issue-tracking.html" />
-            <item name="Team" href="/team.html" />
-            <item name="Source" href="/scm.html" />
-        </menu>
-    </body>
-
-</project>
+    </head>
+    <menu name="Commons Collections">
+      <!-- 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="/download_collections.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-collections4" />
+      </item>
+      <!-- End: For all components. -->
+      <item name="Users guide" href="/userguide.html"/>
+    </menu>
+  </body>
+</site>
diff --git a/src/site/xdoc/building.xml b/src/site/xdoc/building.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>Building</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/compatibility.xml b/src/site/xdoc/compatibility.xml
@@ -15,8 +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>Compatibility</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/history.xml b/src/site/xdoc/history.xml
@@ -15,8 +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>History</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.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>Home</title>
   <author email="[email protected]">Commons Documentation Team</author>
@@ -32,6 +34,7 @@ Since that time it has become the recognised standard for collection handling in
 <p>
 Commons-Collections seek to build upon the JDK classes by providing new interfaces, implementations and utilities.
 There are many features, including:
+</p>
 <ul>
 <li>Bag interface for collections that have a number of copies of each object</li>
 <li>BidiMap interface for maps that can be looked up from value to key as well and key to value</li>
@@ -46,7 +49,6 @@ There are many features, including:
 <li>Adapter classes from array and enumerations to collections</li>
 <li>Utilities to test or create typical set-theory properties of collections such as union, intersection, and closure</li>
 </ul>
-</p>
 </section>
 <!-- ================================================== -->
 <section name="Documentation">

diff --git a/src/site/xdoc/pick.xml b/src/site/xdoc/pick.xml
@@ -15,8 +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>Choosing a collection</title>
   <author email="[email protected]">Commons Documentation Team</author>
@@ -30,7 +31,7 @@
 Commons-Collections and the Java Collections Framework provide a wide variety of collections to choose from. This choice can be bewildering, so this document seeks to help you choose.
 </p>
 
-<script>
+<script type="javascript">
 <![CDATA[
 function showHide(showObj,hideObj) {
  if (document.getElementById) { // DOM3 = IE5, NS6
@@ -90,6 +91,7 @@ For example you could convert a country code to text <i>but not</i> text to coun
 
 <p>
 The <a href="https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/org/apache/commons/collections4/BidiMap.html">BidiMap</a> interface and implementations in Commons Collections allow you to lookup data in both directions. There are three implementations:
+</p>
 <table>
 <tr>
 <td><a href="https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/org/apache/commons/collections4/bidimap/DualHashBidiMap.html">DualHashBidiMap</a></td>
@@ -104,7 +106,6 @@ The <a href="https://commons.apache.org/proper/commons-collections/javadocs/api-
 <td>Dedicated implementation that requires keys and values to implement <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html">Comparable</a>, unless a comparator is supplied. This is an efficient implementation using a data structure that avoids duplicating data. The keys and values are held and viewed in sorted order, and the class implements the <a href="https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/org/apache/commons/collections4/OrderedBidiMap.html">OrderedBidiMap</a> interface.</td>
 </tr>
 </table>
-</p>
 </div>
 
 <!-- ========================================================================= -->
@@ -113,6 +114,7 @@ The <a href="https://commons.apache.org/proper/commons-collections/javadocs/api-
 
 <p>
 The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html">Map</a> interface and implementations in both the JDK and Commons Collections allow you to lookup data from a key to a value. This is one of the most powerful interfaces in the JDK, however it is very difficult to implement. These are the available implementations:
+</p>
 <table>
 <tr>
 <td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html">HashMap</a> (JDK)</td>
@@ -171,7 +173,6 @@ The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html">Map</
 <td>This map is optimised to work well in a heavily loaded multithreaded environment. It provides synchronization internally, locking on a per 'bucket' basis, where the buckets are fixed at construction time. You should use this class if you can predict the size of the map and you are working in a very intensive multithreaded environment.</td>
 </tr>
 </table>
-</p>
 </div>
 
 </div>

diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.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>Proposal</title>
 </properties>

diff --git a/src/site/xdoc/release_3_2.xml b/src/site/xdoc/release_3_2.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>Release notes for version 3.2</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_3_2_1.xml b/src/site/xdoc/release_3_2_1.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>Release notes for version 3.2.1</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_3_2_2.xml b/src/site/xdoc/release_3_2_2.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>Release notes for version 3.2.2</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_4_0.xml b/src/site/xdoc/release_4_0.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>Release notes for version 4.0</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_4_1.xml b/src/site/xdoc/release_4_1.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>Release notes for version 4.1</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_4_2.xml b/src/site/xdoc/release_4_2.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>Release notes for v4.2</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_4_3.xml b/src/site/xdoc/release_4_3.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>Release notes for v4.3</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/release_4_4.xml b/src/site/xdoc/release_4_4.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>Release notes for v4.4</title>
   <author email="[email protected]">Commons Documentation Team</author>

diff --git a/src/site/xdoc/security-reports.xml → src/site/xdoc/security.xml b/src/site/xdoc/security-reports.xml → src/site/xdoc/security.xml
diff --git a/src/site/xdoc/userguide.xml b/src/site/xdoc/userguide.xml
@@ -15,8 +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>User guide</title>
   <author email="[email protected]">Commons Documentation Team</author>