Skip to content

Commit cf4a1e1

Browse files
committed
Normalize main menu on the website
Use XML Schema to validate XML site templates
1 parent 924c2b2 commit cf4a1e1

17 files changed

+80
-52
lines changed

src/site/site.xml

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<project name="Collections">
19-
<bannerRight>
20-
<name>Commons Collections</name>
21-
<src>/images/logo.png</src>
22-
<href>/index.html</href>
23-
</bannerRight>
24-
25-
<body>
26-
<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;
18+
<site xmlns="http://maven.apache.org/SITE/2.0.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 http://maven.apache.org/xsd/site-2.0.0.xsd"
21+
name="Apache Commons Collections">
22+
<bannerRight name="Commons Collections" href="/index.html">
23+
<image src="/images/logo.png"/>
24+
</bannerRight>
25+
<body>
26+
<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;
2727
&lt;style&gt;
2828
.footnotes ol li p {
2929
display: inline;
@@ -42,23 +42,25 @@
4242
}
4343

4444
&lt;/style&gt;
45-
</head>
46-
<menu name="Commons Collections">
47-
<item name="Overview" href="/index.html" />
48-
<item name="Download" href="/download_collections.cgi" />
49-
<item name="User Guide" href="/userguide.html" />
50-
<item name="Javadoc" href="/apidocs/index.html" />
51-
<item name="Javadoc Archive"
52-
href="https://javadoc.io/doc/org.apache.commons/commons-collections4/latest/index.html" />
53-
</menu>
54-
55-
<menu name="Development">
56-
<item name="History" href="/changes.html" />
57-
<item name="Mailing Lists" href="/mail-lists.html" />
58-
<item name="Issue Tracking" href="/issue-tracking.html" />
59-
<item name="Team" href="/team.html" />
60-
<item name="Source" href="/scm.html" />
61-
</menu>
62-
</body>
63-
64-
</project>
45+
</head>
46+
<menu name="Commons Collections">
47+
<!-- Start: For all components. -->
48+
<item name="About" href="index.html" />
49+
<item name="Asking Questions" href="/mail-lists.html" />
50+
<item name="Release History" href="/changes.html" />
51+
<item name="Issue Tracking" href="/issue-management.html" />
52+
<item name="Dependency Management" href="/dependency-info.html" />
53+
<item name="Sources" href="/scm.html" />
54+
<item name="Security" href="security.html" />
55+
<item name="License" href="https://www.apache.org/licenses/LICENSE-2.0" />
56+
<item name="Code of Conduct" href="https://www.apache.org/foundation/policies/conduct.html" />
57+
<item name="Download" href="/download_collections.cgi" />
58+
<item name="Javadoc">
59+
<item name="Javadoc Current" href="apidocs/index.html" />
60+
<item name="Javadoc Archive" href="https://javadoc.io/doc/org.apache.commons/commons-collections4" />
61+
</item>
62+
<!-- End: For all components. -->
63+
<item name="Users guide" href="/userguide.html"/>
64+
</menu>
65+
</body>
66+
</site>

src/site/xdoc/building.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1921
<properties>
2022
<title>Building</title>
2123
<author email="[email protected]">Commons Documentation Team</author>

src/site/xdoc/compatibility.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
19-
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
2021
<properties>
2122
<title>Compatibility</title>
2223
<author email="[email protected]">Commons Documentation Team</author>

src/site/xdoc/history.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
19-
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
2021
<properties>
2122
<title>History</title>
2223
<author email="[email protected]">Commons Documentation Team</author>

src/site/xdoc/index.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1921
<properties>
2022
<title>Home</title>
2123
<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
3234
<p>
3335
Commons-Collections seek to build upon the JDK classes by providing new interfaces, implementations and utilities.
3436
There are many features, including:
37+
</p>
3538
<ul>
3639
<li>Bag interface for collections that have a number of copies of each object</li>
3740
<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:
4649
<li>Adapter classes from array and enumerations to collections</li>
4750
<li>Utilities to test or create typical set-theory properties of collections such as union, intersection, and closure</li>
4851
</ul>
49-
</p>
5052
</section>
5153
<!-- ================================================== -->
5254
<section name="Documentation">

src/site/xdoc/pick.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
19-
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
2021
<properties>
2122
<title>Choosing a collection</title>
2223
<author email="[email protected]">Commons Documentation Team</author>
@@ -30,7 +31,7 @@
3031
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.
3132
</p>
3233

33-
<script>
34+
<script type="javascript">
3435
<![CDATA[
3536
function showHide(showObj,hideObj) {
3637
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
9091

9192
<p>
9293
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:
94+
</p>
9395
<table>
9496
<tr>
9597
<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-
104106
<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>
105107
</tr>
106108
</table>
107-
</p>
108109
</div>
109110

110111
<!-- ========================================================================= -->
@@ -113,6 +114,7 @@ The <a href="https://commons.apache.org/proper/commons-collections/javadocs/api-
113114

114115
<p>
115116
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:
117+
</p>
116118
<table>
117119
<tr>
118120
<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</
171173
<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>
172174
</tr>
173175
</table>
174-
</p>
175176
</div>
176177

177178
</div>

src/site/xdoc/proposal.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1921
<properties>
2022
<title>Proposal</title>
2123
</properties>

src/site/xdoc/release_3_2.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1921
<properties>
2022
<title>Release notes for version 3.2</title>
2123
<author email="[email protected]">Commons Documentation Team</author>

src/site/xdoc/release_3_2_1.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1921
<properties>
2022
<title>Release notes for version 3.2.1</title>
2123
<author email="[email protected]">Commons Documentation Team</author>

src/site/xdoc/release_3_2_2.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1921
<properties>
2022
<title>Release notes for version 3.2.2</title>
2123
<author email="[email protected]">Commons Documentation Team</author>

0 commit comments

Comments
 (0)