Skip to content

Commit 325a5e4

Browse files
garydgregorygarydgregory
committed
Port from Doxia 1 to 2
1 parent c641a27 commit 325a5e4

17 files changed

+100
-65
lines changed

‎src/site/site.xml

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,36 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<project name="Lang">
19-
<bannerRight>
20-
<name>Commons Lang</name>
21-
<src>/images/logo.png</src>
22-
<href>/index.html</href>
23-
</bannerRight>
24-
25-
<body>
26-
<menu name="Lang">
27-
<item name="Overview" href="/index.html" />
28-
<item name="Download" href="/download_lang.cgi" />
29-
<item name="Users guide" href="/userguide.html" />
30-
<item name="Release History" href="/changes.html" />
31-
<item name="Javadoc" href="/apidocs/index.html" />
32-
<item name="Javadoc Archive" href="https://javadoc.io/doc/org.apache.commons/commons-lang3" />
33-
</menu>
34-
35-
<menu name="Development">
36-
<item name="Building" href="/building.html" />
37-
<item name="Mailing Lists" href="/mail-lists.html" />
38-
<item name="Issue Tracking" href="/issue-tracking.html" />
39-
<item name="Proposal" href="/proposal.html" />
40-
<item name="Developer guide" href="/developerguide.html" />
41-
<item name="Source Repository" href="/scm.html" />
42-
</menu>
43-
44-
</body>
45-
46-
</project>
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 https://maven.apache.org/xsd/site-2.0.0.xsd"
21+
name="Apache Commons Lang">
22+
<bannerRight name="Commons Lang" href="/index.html">
23+
<image src="/images/logo.png"/>
24+
</bannerRight>
25+
<body>
26+
<menu name="Commons BCEL">
27+
<!-- Start: For all components. -->
28+
<item name="About" href="/index.html" />
29+
<item name="Asking Questions" href="/mail-lists.html" />
30+
<item name="Release History" href="/changes.html" />
31+
<item name="Issue Tracking" href="/issue-management.html" />
32+
<item name="Dependency Management" href="/dependency-info.html" />
33+
<item name="Sources" href="/scm.html" />
34+
<item name="Security" href="/security.html" />
35+
<item name="License" href="https://www.apache.org/licenses/LICENSE-2.0" />
36+
<item name="Code of Conduct" href="https://www.apache.org/foundation/policies/conduct.html" />
37+
<item name="Download" href="/download_lang.cgi" />
38+
<item name="Javadoc">
39+
<item name="Javadoc Current" href="/apidocs/index.html" />
40+
<item name="Javadoc Archive" href="https://javadoc.io/doc/org.apache.commons/commons-lang3" />
41+
</item>
42+
<!-- End: For all components. -->
43+
<!-- Specific to this component: -->
44+
<item name="Users guide" href="/userguide.html" />
45+
<item name="Building" href="/building.html" />
46+
<item name="Proposal" href="/proposal.html" />
47+
<item name="Developer guide" href="/developerguide.html" />
48+
</menu>
49+
</body>
50+
</site>

‎src/site/xdoc/article2_4.xml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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>What's new in Commons Lang 2.4?</title>
2123
<author email="[email protected]">Commons Documentation Team</author>
@@ -26,6 +28,7 @@ limitations under the License.
2628
<p>Commons Lang 2.4 is out, and the obvious question is: <em>"So what? What's changed?"</em>.</p>
2729
<p>This article aims to briefly cover the changes and save you from having to dig through each JIRA
2830
issue to see what went on in the year of development between Lang 2.3 and 2.4.</p>
31+
</section>
2932
<section name="Deprecations">
3033
<p>First, let us start with a couple of deprecations. As you can see in the release notes, we chose
3134
to deprecate the <a href="https://commons.apache.org/proper/commons-lang/javadocs/api-2.4/org/apache/commons/lang/ObjectUtils.html#appendIdentityToString(java.lang.StringBuffer,%20java.lang.Object)"><code>ObjectUtils.appendIdentityToString(StringBuffer, Object)</code></a> method as its
@@ -60,7 +63,7 @@ followed by a four-digit number, and that it is customary within our organizatio
6063
with a hyphen following the department identifier. Here we'll represent the EIN as a simple
6164
String (of course in real life we would likely create a class composed of department and number).
6265
We can create a custom <code>Format</code> class:
63-
<pre><code>
66+
<source>
6467
public class EINFormat extends Format {
6568
private char[] idMask;
6669

@@ -92,10 +95,10 @@ public class EINFormat extends Format {
9295
return source.substring(idx, endIdx).deleteCharAt(2);
9396
}
9497
}
95-
</code></pre>
98+
</source>
9699
Our custom EIN format is made available for <code>MessageFormat</code>-style processing by a
97100
<code>FormatFactory</code> implementation:
98-
<pre><code>
101+
<source>
99102
public class EINFormatFactory implements FormatFactory {
100103
public static final String EIN_FORMAT = "ein";
101104
public Format getFormat(String name, String arguments, Locale locale) {
@@ -108,19 +111,19 @@ public class EINFormatFactory implements FormatFactory {
108111
return null;
109112
}
110113
}
111-
</code></pre>
114+
</source>
112115

113116
Now you simply provide a <code>java.util.Map&lt;String, FormatFactory&gt;</code> registry (keyed
114117
by format type) to <code>ExtendedMessageFormat</code>:
115-
<pre><code>
118+
<source>
116119
new ExtendedMessageFormat("EIN: {0,ein}", Collections.singletonMap(EINFormatFactory.EIN_FORMAT, new EINFormatFactory()));
117-
</code></pre>
120+
</source>
118121
As expected, this will render a String EIN "AA9999" as: <code>"EIN: AA-9999"</code>.
119122
<br /> <br />
120123
If we wanted to trigger the EIN masking code, we could trigger that in the format pattern:
121-
<pre><code>
124+
<source>
122125
new ExtendedMessageFormat("EIN: {0,ein,#}", Collections.singletonMap(EINFormatFactory.EIN_FORMAT, new EINFormatFactory()));
123-
</code></pre>
126+
</source>
124127
This should render "AA9999" as: <code>"EIN: AA-####"</code>.
125128
<br /> <br />
126129
You can also use <code>ExtendedMessageFormat</code> to override any or all of the built-in
@@ -189,7 +192,5 @@ and fortunately there are some nice groupings that we can discuss instead:</p>
189192
<p>Hopefully that was all of interest. Don't forget to download <a href="https://commons.apache.org/lang/download_lang.cgi">Lang 2.4</a>, or, for the Maven repository users, upgrade your &lt;version&gt; tag to 2.4. Please feel free to raise any questions you might have on the <a href="mail-lists.html">mailing lists</a>, and report bugs or enhancements in the <a href="issue-tracking.html">issue tracker</a>.</p>
190193
</section>
191194

192-
</section>
193-
194195
</body>
195196
</document>

‎src/site/xdoc/article2_5.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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>What's new in Commons Lang 2.5?</title>
2123
<author email="[email protected]">Commons Documentation Team</author>
@@ -28,6 +30,7 @@ limitations under the License.
2830
issue to see what went on in the two years of development between Lang 2.4 and 2.5.</p>
2931
<p>Two years?!? Yes, it's true. The reason is that 2.5 represents the backwards compatible changes in the
3032
nearly complete Java-5 focused Lang 3.0. </p>
33+
</section>
3134
<section name="Deprecations">
3235
<p>There were no new deprecations in 2.5. </p>
3336
</section>
@@ -129,7 +132,5 @@ ToStringStyle meant that containers could end up with memory leaks. This was rew
129132
<p>Hopefully that was all of interest. Don't forget to download <a href="https://commons.apache.org/lang/download_lang.cgi">Lang 2.5</a>, or, for the Maven repository users, upgrade your &lt;version&gt; tag to 2.5. Please feel free to raise any questions you might have on the <a href="mail-lists.html">mailing lists</a>, and report bugs or enhancements in the <a href="issue-tracking.html">issue tracker</a>.</p>
130133
</section>
131134

132-
</section>
133-
134135
</body>
135136
</document>

‎src/site/xdoc/article3_0.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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>What's new in Commons Lang 3.0?</title>
2123
<author email="[email protected]">Commons Documentation Team</author>
@@ -24,6 +26,7 @@ limitations under the License.
2426

2527
<section name="What's new in Commons Lang 3.0?">
2628
<p>Commons Lang 3.0 is out, and the obvious question is: <em>"So what? What's changed?"</em>.</p>
29+
</section>
2730
<section name="The big story">
2831
<p>Lang is now Java 5 based. We've generified the API, moved certain APIs to support <code>varargs</code> and thrown out any features
2932
that are now supported by Java itself. We've removed the deprecated parts of the API and have also removed some features that
@@ -84,11 +87,11 @@ some additional classes in this area which are intended to further simplify the
8487
development of concurrent applications.</p>
8588
<p>The classes located in the <code>concurrent</code> package can be roughly
8689
divided into the following categories:
90+
</p>
8791
<ul>
8892
<li>Utility classes</li>
8993
<li>Initializer classes</li>
9094
</ul>
91-
</p>
9295
<p>Classes of the former category provide some basic functionality a developer
9396
typically has to implement manually again and again. Examples are a configurable
9497
<code>ThreadFactory</code> implementation or utility methods for the handling of
@@ -202,7 +205,5 @@ general-purpose mechanism to raise an <code>IllegalArgumentException</code>.</li
202205
</section>
203206
-->
204207

205-
</section>
206-
207208
</body>
208209
</document>

‎src/site/xdoc/building.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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/developerguide.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1414
See the License for the specific language governing permissions and
1515
limitations under the License.
1616
-->
17-
<document>
17+
<document xmlns="http://maven.apache.org/XDOC/2.0"
18+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
19+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1820
<properties>
1921
<title>Developer guide for Commons "Lang"</title>
2022
</properties>
@@ -140,11 +142,11 @@ The currently targeted version of Java is 1.6.
140142
</p>
141143
<p>
142144
To build Lang:
145+
</p>
143146
<table>
144147
<tr><th></th><th>Tested JAR</th><th>Distribution</th><th>Site</th></tr>
145148
<tr><td>Maven 2.x</td><td><code>mvn package</code></td><td>mvn assembly:assembly</td><td>mvn site</td></tr>
146149
</table>
147-
</p>
148150
</section>
149151
</body>
150152
</document>

‎src/site/xdoc/index.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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>

‎src/site/xdoc/proposal.xml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1414
See the License for the specific language governing permissions and
1515
limitations under the License.
1616
-->
17-
<document>
17+
<document xmlns="http://maven.apache.org/XDOC/2.0"
18+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
19+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1820
<properties>
1921
<title>Proposal for Lang Package</title>
2022
</properties>
@@ -83,13 +85,14 @@ several existing components in the open source world.</p>
8385
</subsection>
8486
<subsection name="(4) Initial Committers">
8587

86-
<p>The initial committers on the Lang component shall be as follows:
88+
<p>
89+
The initial committers on the Lang component shall be as follows:
90+
</p>
8791
<ul>
8892
<li>Henri Yandell (bayard)</li>
8993
<li>Daniel Rall (dlr)</li>
9094
<li>Stephen Colebourne (scolebourne)</li>
9195
</ul>
92-
</p>
9396

9497
</subsection>
9598
</section>

‎src/site/xdoc/upgradeto2_0.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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>2.0 Release Notes</title>
2123
<author email="[email protected]">Commons Documentation Team</author>

‎src/site/xdoc/upgradeto2_1.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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>2.1 Release Notes</title>
2123
<author email="[email protected]">Commons Documentation Team</author>

0 commit comments

Comments
 (0)