This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-build-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new e747a19 Clean up comments for spelling, grammar, and readability
e747a19 is described below
commit e747a196ed3a7a8242709b6a0212acd37ce900bc
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Oct 30 07:17:40 2026 -0400
Clean up comments for spelling, grammar, and readability
Paragraph tags on their own lines.
---
CONTRIBUTING.md | 2 +-
RELEASE-NOTES.txt | 16 +--
pom.xml | 4 +-
src/changes/changes.xml | 28 ++---
.../contributing-md-template.md | 2 +-
.../issue-tracking-template.xml | 4 +-
.../sandbox-issue-tracking-template.xml | 4 +-
src/main/scripts/copy-javadoc-files.build.xml | 2 +-
src/main/scripts/generate-xdocs.build.xml | 34 +++---
src/main/scripts/generate-xdocs.mojos.xml | 24 ++--
src/site/xdoc/all-mojo.xml | 28 +++--
src/site/xdoc/all-sandbox-mojo.xml | 28 +++--
src/site/xdoc/contributing-md-mojo.xml | 30 +++--
src/site/xdoc/contributing-md.xml | 2 +-
src/site/xdoc/copy-javadoc-files-mojo.xml | 25 ++++-
src/site/xdoc/download-page-mojo.xml | 123 +++++++++++++++------
src/site/xdoc/download-page.xml | 2 +-
src/site/xdoc/index.xml | 8 +-
src/site/xdoc/issue-tracking.xml | 4 +-
src/site/xdoc/jira-page-mojo.xml | 35 ++++--
src/site/xdoc/jira-page.xml | 4 +-
src/site/xdoc/mail-page-mojo.xml | 25 ++++-
src/site/xdoc/mail-page.xml | 4 +-
src/site/xdoc/notice-txt-mojo.xml | 34 ++++--
src/site/xdoc/notice-txt.xml | 11 +-
src/site/xdoc/readme-md-mojo.xml | 35 ++++--
src/site/xdoc/readme-md.xml | 4 +-
src/site/xdoc/sandbox-jira-page-mojo.xml | 30 +++--
src/site/xdoc/sandbox-jira-page.xml | 4 +-
29 files changed, 380 insertions(+), 176 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1de2dcc..394ed35 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,7 +61,7 @@ Making Changes
+ Create a _topic branch_ for your isolated work.
* Usually, you should base your branch on the `master` branch.
- * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.,
`COMMONSSITE-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, for
example, `COMMONSSITE-123-InputStream`.
* If you have submitted multiple JIRA issues, try to maintain separate
branches and pull requests.
+ Make commits of logical units.
* Make sure your commit messages are meaningful and in the proper format.
Your commit message should contain the key of the JIRA issue.
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 3ff8e50..26bc619 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -69,7 +69,7 @@ Fixed Bugs
----------
* Migrate site generation templates to
https://maven.apache.org/xsd/xdoc-2.0.xsd. Thanks to Gary Gregory.
-* Remove -nouses directive from maven-bundle-plugin. OSGi
package imports now state 'uses' definitions for package imports, this doesn't
affect JPMS (from org.apache.commons:commons-parent:80). Thanks to Gary Gregory.
+* Remove -nouses directive from maven-bundle-plugin. OSGi
package imports now state 'uses' definitions for package imports; this doesn't
affect JPMS (from org.apache.commons:commons-parent:80). Thanks to Gary Gregory.
Changes
-------
@@ -98,7 +98,7 @@ Apache Maven Mojo for Apache Commons Build tasks.
For example:
mvn commons-build:download-page [-Dcommons.release.version=1.2.3]
-To use a SNAPSHOT version (for testing etc)
+To use a SNAPSHOT version (for testing and so on):
mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page
[-Dcommons.release.version=1.2.3]
This is a maintenance release.
@@ -133,7 +133,7 @@ Apache Maven Mojo for Apache Commons Build tasks.
For example:
mvn commons-build:download-page [-Dcommons.release.version=1.2.3]
-To use a SNAPSHOT version (for testing etc)
+To use a SNAPSHOT version (for testing and so on):
mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page
[-Dcommons.release.version=1.2.3]
Maintenance release
@@ -181,7 +181,7 @@ Apache Maven Mojo for Apache Commons Build tasks.
For example:
mvn commons-build:download-page [-Dcommons.release.version=1.2.3]
-To use a SNAPSHOT version (for testing etc)
+To use a SNAPSHOT version (for testing and so on):
mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page
[-Dcommons.release.version=1.2.3]
Feature release
@@ -211,7 +211,7 @@ Changes
* Bump commons-parent from 58 to 69 #240. Thanks to Gary
Gregory.
* Bump org.apache.ant:ant-launcher from 1.10.12 to 1.10.14.
Thanks to Dependabot, Gary Gregory.
* Disable cyclonedx - not needed
-* Drop outdated, unmaintained table of components in README
in favour of link to website.
+* Drop outdated, unmaintained table of components in README
in favor of a link to the website.
* Bump org.graalvm.js:js-scriptengine from 23.1.0 to 24.0.0
#236. Thanks to Dependabot.
* Bump org.graalvm.js:js from 23.0.1 to 23.0.3. Thanks to
Dependabot.
* Bump org.apache.maven:maven-core 3.9.4 to 3.9.6. Thanks to
Gary Gregory.
@@ -237,7 +237,7 @@ Apache Maven Mojo for Apache Commons Build tasks.
For example:
mvn commons-build:download-page [-Dcommons.release.version=1.2.3]
-To use a SNAPSHOT version (for testing etc)
+To use a SNAPSHOT version (for testing and so on):
mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page
[-Dcommons.release.version=1.2.3]
Feature release
@@ -267,7 +267,7 @@ Changes
* Bump commons-parent from 58 to 69 #240. Thanks to Gary
Gregory.
* Bump org.apache.ant:ant-launcher from 1.10.12 to 1.10.14.
Thanks to Dependabot, Gary Gregory.
* Disable cyclonedx - not needed
-* Drop outdated, unmaintained table of components in README
in favour of link to website.
+* Drop outdated, unmaintained table of components in README
in favor of a link to the website.
* Bump org.graalvm.js:js-scriptengine from 23.1.0 to 24.0.0
#236. Thanks to Dependabot.
* Bump org.graalvm.js:js from 23.0.1 to 23.0.3. Thanks to
Dependabot.
* Bump org.apache.maven:maven-core 3.9.4 to 3.9.6. Thanks to
Gary Gregory.
@@ -294,7 +294,7 @@ Apache Maven Mojo for Apache Commons Build tasks.
For example:
mvn commons-build:download-page [-Dcommons.release.version=1.2.3]
-To use a SNAPSHOT version (for testing etc)
+To use a SNAPSHOT version (for testing and so on):
mvn org.apache.commons:commons-build-plugin:1.13-SNAPSHOT:download-page
[-Dcommons.release.version=1.2.3]
Feature release
diff --git a/pom.xml b/pom.xml
index fbb20a8..4bf4712 100644
--- a/pom.xml
+++ b/pom.xml
@@ -167,7 +167,7 @@
<artifactId>apache-rat-plugin</artifactId>
<configuration>
<inputExcludes>
- <!-- template files which will be inserted into the middle of
resulting page -->
+ <!-- template files which will be inserted into the middle of the
resulting page -->
<inputExclude>src/main/resources/commons-xdoc-templates/download-page-body.xml</inputExclude>
<inputExclude>src/main/resources/commons-xdoc-templates/download-page-foot.xml</inputExclude>
<inputExclude>src/main/resources/commons-xdoc-templates/notice-txt-template.txt</inputExclude>
@@ -194,7 +194,7 @@
<artifactId>apache-rat-plugin</artifactId>
<configuration>
<inputExcludes>
- <!-- template files which will be inserted into the middle of
resulting page -->
+ <!-- template files which will be inserted into the middle of the
resulting page -->
<inputExclude>src/main/resources/commons-xdoc-templates/download-page-body.xml</inputExclude>
<inputExclude>src/main/resources/commons-xdoc-templates/download-page-foot.xml</inputExclude>
<inputExclude>src/main/resources/commons-xdoc-templates/notice-txt-template.txt</inputExclude>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 95b8261..ac16a3b 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -58,7 +58,7 @@
<release version="1.16.0" date="2025-07-19" description="This is a feature
and maintenance release. Java 8 or later is required.">
<!-- FIX -->
<action type="fix" dev="ggregory" due-to="Gary Gregory">Migrate site
generation templates to https://maven.apache.org/xsd/xdoc-2.0.xsd.</action>
- <action type="fix" dev="ggregory" due-to="Gary Gregory">Remove -nouses
directive from maven-bundle-plugin. OSGi package imports now state 'uses'
definitions for package imports, this doesn't affect JPMS (from
org.apache.commons:commons-parent:80).</action>
+ <action type="fix" dev="ggregory" due-to="Gary Gregory">Remove -nouses
directive from maven-bundle-plugin. OSGi package imports now state 'uses'
definitions for package imports; this doesn't affect JPMS (from
org.apache.commons:commons-parent:80).</action>
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary Gregory">Refactor version
for Maven core plugin dependencies into a new property
commons.maven.version.</action>
<action type="add" dev="ggregory" due-to="Gary Gregory">Refactor unnamed
profile into two for JavaScript dependency: java-11 and java-17-plus.</action>
@@ -89,10 +89,10 @@
<action dev="ggregory" type="update" due-to="Dependabot">Bump
org.apache.maven:maven-core from 3.9.6 to 3.9.9 #268, #278, #294.</action>
<action dev="ggregory" type="update" due-to="Dependabot">Bump
org.apache.ant:ant-launcher from 1.10.14 to 1.10.15 #303.</action>
<action dev="ggregory" type="update" due-to="Dependabot">Bump
org.codehaus.mojo:jdepend-maven-plugin from 2.0 to 2.1 #311.</action>
- <!-- REMVOE -->
+ <!-- REMOVE -->
<action dev="ggregory" type="remove" due-to="Gary Gregory">Drop
codecov.io badge.</action>
</release>
- <release version="1.14.0" date="2024-04-12" description="This is feature
release.">
+ <release version="1.14.0" date="2024-04-12" description="This is a feature
release.">
<!-- FIX -->
<action dev="sebb" type="fix">maven-plugin-report-plugin replaces
maven-plugin-plugin report goal</action>
<action dev="sebb" type="fix">Fix up errors in GHA badges for Java and
CodeQL</action>
@@ -108,7 +108,7 @@
<action dev="ggregory" type="update" due-to="Gary Gregory">Bump
commons-parent from 58 to 69 #240.</action>
<action dev="ggregory" type="update" due-to="Dependabot, Gary
Gregory">Bump org.apache.ant:ant-launcher from 1.10.12 to 1.10.14.</action>
<action dev="sebb" type="update">Disable cyclonedx - not needed</action>
- <action dev="sebb" type="update">Drop outdated, unmaintained table of
components in README in favour of link to website.</action>
+ <action dev="sebb" type="update">Drop outdated, unmaintained table of
components in README in favor of a link to the website.</action>
<action dev="ggregory" type="update" due-to="Dependabot">Bump
org.graalvm.js:js-scriptengine from 23.1.0 to 24.0.0 #236.</action>
<action dev="ggregory" type="update" due-to="Dependabot">Bump
org.graalvm.js:js from 23.0.1 to 23.0.3.</action>
<action dev="ggregory" type="update" due-to="Gary Gregory">Bump
org.apache.maven:maven-core 3.9.4 to 3.9.6.</action>
@@ -117,7 +117,7 @@
<action dev="ggregory" type="update" due-to="Gary Gregory">Bump
org.apache.maven.plugin-tools:maven-plugin-tools-ant from 3.9.0 to 3.12.0
#242.</action>
<action dev="ggregory" type="update" due-to="Dependabot, Gary
Gregory">Bump org.apache.maven.plugins:maven-artifact-plugin from 3.5.0 to
3.5.1 #393.</action>
</release>
- <release version="1.13" date="2023-06-25" description="This is feature
release.">
+ <release version="1.13" date="2023-06-25" description="This is a feature
release.">
<!-- FIX -->
<action dev="ggregory" type="fix" due-to="Gary Gregory">
Fix running on Java 11 and up. Use GraalVM instead of Java 8 Nashorn
for JavaScript, which was deprecated in Java 11 and removed in Java 15.
@@ -190,7 +190,7 @@
Bump commons-parent from 52 to 61 #67, #86, #110, #120, #153.
</action>
</release>
- <release version="1.12" date="2020-10-17" description="This is feature
release.">
+ <release version="1.12" date="2020-10-17" description="This is a feature
release.">
<action dev="sebb" type="update">
commons-build:mail-page - add links to lists.apache.org.
</action>
@@ -213,7 +213,7 @@
Update actions/setup-java from v1.4.0 to v1.4.2 #13.
</action>
</release>
- <release version="1.11" date="2019-08-30" description="This is feature
release.">
+ <release version="1.11" date="2019-08-30" description="This is a feature
release.">
<action dev="ggregory" type="update">
Update versions-maven-plugin 2.5 -> 2.7.
</action>
@@ -230,7 +230,7 @@
Replace http://mail-archives.apache.org with
https://mail-archives.apache.org.
</action>
</release>
- <release version="1.10" date="2019-02-26" description="This is feature
release.">
+ <release version="1.10" date="2019-02-26" description="This is a feature
release.">
<action dev="ggregory" type="update">
Use SHA512 signatures as the default in the download page.
</action>
@@ -238,7 +238,7 @@
Use SHA256 signatures as the default in the download page.
</action>
</release>
- <release version="1.9" date="2018-06-16" description="This is feature
release.">
+ <release version="1.9" date="2018-06-16" description="This is a feature
release.">
<action dev="ggregory" type="fix">
Fix in src/main/resources/commons-xdoc-templates/readme-md-template.md
for components that have a major version number in their artifact IDs.
</action>
@@ -258,7 +258,7 @@
Update platform requirement from Java 7 to Java 8.
</action>
</release>
- <release version="1.8" date="2018-04-02" description="This is feature
release.">
+ <release version="1.8" date="2018-04-02" description="This is a feature
release.">
<action dev="sebb" type="update">
Use sha1 signatures as opposed to md5 signatures in download page.
</action>
@@ -266,10 +266,10 @@
Include Javadoc badge in README.md file.
</action>
<action dev="sebb" type="fix">
- Add eol-style:native otherwise generated files can cause commit errors
+ Add eol-style:native; otherwise, generated files can cause commit
errors.
</action>
</release>
- <release version="1.7" date="2016-11-18" description="This is feature
release.">
+ <release version="1.7" date="2016-11-18" description="This is a feature
release.">
<action dev="ggregory" type="add" issue="COMMONSSITE-90">
Include badges in the README.md file.
</action>
@@ -278,9 +278,9 @@
</action>
</release>
- <release version="1.6" date="2016-04-24" description="This is feature
release.">
+ <release version="1.6" date="2016-04-24" description="This is a feature
release.">
<action dev="sebb" type="add">
- Added new download-page subdir property: set this (e.g. to '1.2' or
'lang-1.2' etc) to override the default of binaries/source
+ Added new download-page subdir property: set this (for example, to
'1.2' or 'lang-1.2') to override the default of binaries/source
</action>
</release>
diff --git
a/src/main/resources/commons-xdoc-templates/contributing-md-template.md
b/src/main/resources/commons-xdoc-templates/contributing-md-template.md
index dc1d5fc..d99c908 100644
--- a/src/main/resources/commons-xdoc-templates/contributing-md-template.md
+++ b/src/main/resources/commons-xdoc-templates/contributing-md-template.md
@@ -61,7 +61,7 @@ Making Changes
+ Create a _topic branch_ for your isolated work.
* Usually, you should base your branch on the `master` branch.
- * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.,
`@JIRA_ID@-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, for
example, `@JIRA_ID@-123-InputStream`.
* If you have submitted multiple JIRA issues, try to maintain separate
branches and pull requests.
+ Make commits of logical units.
* Make sure your commit messages are meaningful and in the proper format.
Your commit message should contain the key of the JIRA issue.
diff --git
a/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
b/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
index 6d15d41..c2a6f7a 100644
--- a/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
+++ b/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
@@ -58,13 +58,13 @@ limitations under the License.
<p>
To use JIRA, you may need to <a
href="https://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
- (if you have previously created/updated Commons issues using Bugzilla,
an account will have been automatically
+ (if you have previously created or updated Commons issues using
Bugzilla, an account will have been automatically
created and you can use the <a
href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
page to get a new password).
</p>
<p>
- If you would like to report a bug, or raise an enhancement request with
+ If you would like to report a bug or request an enhancement for
@NAME@, please do the following:
</p>
<ol>
diff --git
a/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
b/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
index c4df80b..b208db0 100644
---
a/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
+++
b/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
@@ -56,13 +56,13 @@ limitations under the License.
<p>
To use JIRA, you may need to <a
href="https://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
- (if you have previously created/updated Commons issues using Bugzilla,
an account will have been automatically
+ (if you have previously created or updated Commons issues using
Bugzilla, an account will have been automatically
created and you can use the <a
href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
page to get a new password).
</p>
<p>
- If you would like to report a bug, or raise an enhancement request with
+ If you would like to report a bug or request an enhancement for
@NAME@, please do the following:
</p>
<ol>
diff --git a/src/main/scripts/copy-javadoc-files.build.xml
b/src/main/scripts/copy-javadoc-files.build.xml
index 0a38119..5900106 100644
--- a/src/main/scripts/copy-javadoc-files.build.xml
+++ b/src/main/scripts/copy-javadoc-files.build.xml
@@ -25,7 +25,7 @@
<echo level="info" message="**** commons-build:copy-javadoc-files -
Copying NOTICE and LICENSE files ****" />
- <!-- Copy pages, filtering parameter values -->
+ <!-- Copy the NOTICE and LICENSE files -->
<copy todir="target/apidocs/META-INF">
<fileset dir=".">
<include name="NOTICE.txt"/>
diff --git a/src/main/scripts/generate-xdocs.build.xml
b/src/main/scripts/generate-xdocs.build.xml
index 5799470..cebf716 100644
--- a/src/main/scripts/generate-xdocs.build.xml
+++ b/src/main/scripts/generate-xdocs.build.xml
@@ -44,13 +44,13 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the issue-tracking template from mojo resources to
temp directory -->
+ <!-- Load the mail-lists template from the mojo resources to
the temporary directory -->
<loadresource property="mailinglists-xml">
<javaresource
name="${commonsMojoXdocDir}/mail-lists-template.xml" />
</loadresource>
<echo message="${mailinglists-xml}"
file="${commonsMojoTempDir}/mail-lists-template.xml" append="false" />
- <!-- Copy the mail-lists template filtering to replace
properties -->
+ <!-- Copy the mail-lists template, filtering to replace
properties -->
<copy file="${commonsMojoTempDir}/mail-lists-template.xml"
tofile="${commonsMojoTempDir}/mail-lists.xml" overwrite="true">
<filterset>
<filter token="NAME" value="${project.name}" />
@@ -58,7 +58,7 @@
</filterset>
</copy>
- <!-- copy to either m1 or m2 xdoc directory -->
+ <!-- Copy to either the Maven 1 or Maven 2 xdoc directory -->
<antcall target="copy-to-xdoc-dir">
<param name="file.name" value="mail-lists.xml" />
</antcall>
@@ -81,13 +81,13 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the issue-tracking template from mojo resources to
temp directory -->
+ <!-- Load the issue-tracking template from the mojo resources
to the temporary directory -->
<loadresource property="issuetracking-xml">
<javaresource
name="${commonsMojoXdocDir}/issue-tracking-template.xml" />
</loadresource>
<echo message="${issuetracking-xml}"
file="${commonsMojoTempDir}/issue-tracking-template.xml" append="false" />
- <!-- Copy the issue-tracking template filtering to replace
properties -->
+ <!-- Copy the issue-tracking template, filtering to replace
properties -->
<copy file="${commonsMojoTempDir}/issue-tracking-template.xml"
tofile="${commonsMojoTempDir}/issue-tracking.xml" overwrite="true">
<filterset>
<filter token="NAME" value="${project.name}" />
@@ -96,7 +96,7 @@
</filterset>
</copy>
- <!-- copy to either m1 or m2 xdoc directory -->
+ <!-- Copy to either the Maven 1 or Maven 2 xdoc directory -->
<antcall target="copy-to-xdoc-dir">
<param name="file.name" value="issue-tracking.xml" />
</antcall>
@@ -118,13 +118,13 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the issue-tracking template from mojo resources to
temp directory -->
+ <!-- Load the issue-tracking template from the mojo resources
to the temporary directory -->
<loadresource property="sandbox-issuetracking-xml">
<javaresource
name="${commonsMojoXdocDir}/sandbox-issue-tracking-template.xml" />
</loadresource>
<echo message="${sandbox-issuetracking-xml}"
file="${commonsMojoTempDir}/sandbox-issue-tracking-template.xml" append="false"
/>
- <!-- Copy the issue-tracking template filtering to replace
properties -->
+ <!-- Copy the issue-tracking template, filtering to replace
properties -->
<copy
file="${commonsMojoTempDir}/sandbox-issue-tracking-template.xml"
tofile="${commonsMojoTempDir}/issue-tracking.xml" overwrite="true">
<filterset>
<filter token="NAME" value="${project.name}" />
@@ -132,7 +132,7 @@
</filterset>
</copy>
- <!-- copy to either m1 or m2 xdoc directory -->
+ <!-- Copy to either the Maven 1 or Maven 2 xdoc directory -->
<antcall target="copy-to-xdoc-dir">
<param name="file.name" value="issue-tracking.xml" />
</antcall>
@@ -192,7 +192,7 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the download-page template from mojo resources to
temp directory -->
+ <!-- Load the download-page template from the mojo resources to
the temporary directory -->
<antcall target="load-no-download-page-template" />
<antcall target="load-download-page-head" />
<antcall target="load-download-page-body-1" />
@@ -201,7 +201,7 @@
<antcall target="load-download-page-body-4" />
<antcall target="load-download-page-foot" />
- <!-- copy to either m1 or m2 xdoc directory -->
+ <!-- Copy to either the Maven 1 or Maven 2 xdoc directory -->
<antcall target="copy-to-xdoc-dir">
<param name="file.name"
value="download_${commons.componentid}.xml" />
</antcall>
@@ -456,7 +456,7 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the readme-md template from mojo resources to temp
directory -->
+ <!-- Load the readme-md template from the mojo resources to the
temporary directory -->
<loadresource property="readme-md">
<javaresource
name="${commonsMojoXdocDir}/readme-md-template.md" />
</loadresource>
@@ -473,7 +473,7 @@
</filterchain>
</loadresource>
- <!-- Copy the readme-md template filtering to replace
properties -->
+ <!-- Copy the readme-md template, filtering to replace
properties -->
<copy file="${commonsMojoTempDir}/readme-md-template.md"
tofile="README.md" overwrite="true">
<filterset>
<filter token="NAME" value="${project.name}" />
@@ -509,13 +509,13 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the notice-txt template from mojo resources to temp
directory -->
+ <!-- Load the notice-txt template from the mojo resources to
the temporary directory -->
<loadresource property="notice-txt">
<javaresource
name="${commonsMojoXdocDir}/notice-txt-template.txt" />
</loadresource>
<echo message="${notice-txt}"
file="${commonsMojoTempDir}/notice-txt-template.txt" append="false" />
- <!-- Copy the notice-txt template filtering to replace
properties -->
+ <!-- Copy the notice-txt template, filtering to replace
properties -->
<copy file="${commonsMojoTempDir}/notice-txt-template.txt"
tofile="NOTICE.txt" overwrite="true">
<filterset>
<filter token="NAME" value="${project.name}" />
@@ -542,7 +542,7 @@
<!-- Create a temporary directory to load the template files
into -->
<mkdir dir="${commonsMojoTempDir}" />
- <!-- Load the contributing-md template from mojo resources to
temp directory -->
+ <!-- Load the contributing-md template from the mojo resources
to the temporary directory -->
<loadresource property="contributing-md">
<javaresource
name="${commonsMojoXdocDir}/contributing-md-template.md" />
</loadresource>
@@ -559,7 +559,7 @@
</filterchain>
</loadresource>
- <!-- Copy the mail-lists template filtering to replace
properties -->
+ <!-- Copy the contributing-md template, filtering to replace
properties -->
<copy file="${commonsMojoTempDir}/contributing-md-template.md"
tofile="CONTRIBUTING.md" overwrite="true">
<filterset>
<filter token="NAME" value="${project.name}" />
diff --git a/src/main/scripts/generate-xdocs.mojos.xml
b/src/main/scripts/generate-xdocs.mojos.xml
index eb8260a..700dd2f 100644
--- a/src/main/scripts/generate-xdocs.mojos.xml
+++ b/src/main/scripts/generate-xdocs.mojos.xml
@@ -164,7 +164,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.2.* -->
<parameter>
@@ -219,7 +219,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.3.* -->
<parameter>
@@ -274,7 +274,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.4.* -->
<parameter>
@@ -329,7 +329,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
</parameters>
</mojo>
@@ -445,7 +445,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.2.* -->
<parameter>
@@ -500,7 +500,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.3.* -->
<parameter>
@@ -555,7 +555,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.4.* -->
<parameter>
@@ -610,7 +610,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
</parameters>
</mojo>
@@ -786,7 +786,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.2.* -->
<parameter>
@@ -841,7 +841,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.3.* -->
<parameter>
@@ -896,7 +896,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
<!-- commons.release.4.* -->
<parameter>
@@ -951,7 +951,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lowercase, e.g.,
sha512)</description>
+ <description>Type of hash (lowercase, for example,
sha512)</description>
</parameter>
</parameters>
</mojo>
diff --git a/src/site/xdoc/all-mojo.xml b/src/site/xdoc/all-mojo.xml
index d3a1e29..df3f092 100644
--- a/src/site/xdoc/all-mojo.xml
+++ b/src/site/xdoc/all-mojo.xml
@@ -23,23 +23,37 @@
</properties>
<body>
<section name="commons-build:all">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:all</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:all
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate all pages</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
</ul>
<subsection name="Required Parameters">
- <p>This is the union of all parameters for all goals in this
plugin.</p>
+ <p>
+ This is the union of all parameters for all goals in this plugin.
+ </p>
</subsection>
<subsection name="Optional Parameters">
- <p>This is the union of all parameters for all goals in this
plugin.</p>
+ <p>
+ This is the union of all parameters for all goals in this plugin.
+ </p>
</subsection>
<subsection name="Parameter Details">
- <p>This is the union of all parameters for all goals in this
plugin.</p>
+ <p>
+ This is the union of all parameters for all goals in this plugin.
+ </p>
</subsection>
</section>
</body>
diff --git a/src/site/xdoc/all-sandbox-mojo.xml
b/src/site/xdoc/all-sandbox-mojo.xml
index 3fcc211..e5f486d 100644
--- a/src/site/xdoc/all-sandbox-mojo.xml
+++ b/src/site/xdoc/all-sandbox-mojo.xml
@@ -23,23 +23,37 @@
</properties>
<body>
<section name="commons-build:all-sandbox">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:all-sandbox</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:all-sandbox
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate all sandbox pages</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
</ul>
<subsection name="Required Parameters">
- <p>This is the union of all parameters for all goals in this
plugin.</p>
+ <p>
+ This is the union of all parameters for all goals in this plugin.
+ </p>
</subsection>
<subsection name="Optional Parameters">
- <p>This is the union of all parameters for all goals in this
plugin.</p>
+ <p>
+ This is the union of all parameters for all goals in this plugin.
+ </p>
</subsection>
<subsection name="Parameter Details">
- <p>This is the union of all parameters for all goals in this
plugin.</p>
+ <p>
+ This is the union of all parameters for all goals in this plugin.
+ </p>
</subsection>
</section>
</body>
diff --git a/src/site/xdoc/contributing-md-mojo.xml
b/src/site/xdoc/contributing-md-mojo.xml
index 1029458..2b68829 100644
--- a/src/site/xdoc/contributing-md-mojo.xml
+++ b/src/site/xdoc/contributing-md-mojo.xml
@@ -22,11 +22,19 @@
</properties>
<body>
<section name="commons-build:contributing-md">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:contributing-md</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:contributing-md
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate CONTRIBUTING.md</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -70,20 +78,28 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a name="commons.jira.id">commons.jira.id</a>:</strong></p>
+ <p>
+ <strong><a name="commons.jira.id">commons.jira.id</a>:</strong>
+ </p>
<div>The external JIRA ID for the project (alphabetic, uppercase)</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>${commons.jira.id}</code></li>
- </ul><hr/><p><strong><a
name="commons.jira.pid">commons.jira.pid</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="commons.jira.pid">commons.jira.pid</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/contributing-md.xml
b/src/site/xdoc/contributing-md.xml
index f21a907..8363c78 100644
--- a/src/site/xdoc/contributing-md.xml
+++ b/src/site/xdoc/contributing-md.xml
@@ -49,7 +49,7 @@
Ant script</li>
<li>Uses the <a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/contributing-md-template.md";>contributing-md-template.md</a>
template</li>
- <li>Uses the <a href="contributing-md-mojo.html">goal's
(i.e., mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="contributing-md-mojo.html">goal's
(mojo's) parameters</a> to filter values in the template</li>
</ul>
</subsection>
diff --git a/src/site/xdoc/copy-javadoc-files-mojo.xml
b/src/site/xdoc/copy-javadoc-files-mojo.xml
index e7a7330..c651864 100644
--- a/src/site/xdoc/copy-javadoc-files-mojo.xml
+++ b/src/site/xdoc/copy-javadoc-files-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:copy-javadoc-files">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:copy-javadoc-files</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:copy-javadoc-files
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Commons Build: Copy NOTICE and LICENSE files to -javadoc.jar</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Is NOT inherited by default in multi-project builds.</li>
</ul>
@@ -64,14 +72,19 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a name="basedir">basedir</a>:</strong></p>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/download-page-mojo.xml
b/src/site/xdoc/download-page-mojo.xml
index a8d7347..0ad74b8 100644
--- a/src/site/xdoc/download-page-mojo.xml
+++ b/src/site/xdoc/download-page-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:download-page">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:download-page</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:download-page
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate Download page</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -90,7 +98,7 @@
<td><strong><a
href="#commons.binary.suffix">commons.binary.suffix</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The suffix for the binary distro.<br/><strong>Default value
is</strong>: <code>${commons.binary.suffix}</code>.</td>
+ <td>The suffix for the binary distribution.<br/><strong>Default
value is</strong>: <code>${commons.binary.suffix}</code>.</td>
</tr>
<tr>
<td><strong><a
href="#commons.release.desc">commons.release.desc</a></strong></td>
@@ -121,7 +129,7 @@
<td><strong><a
href="#commons.release.2.binary.suffix">commons.release.2.binary.suffix</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The suffix for the alternative release binary
distro.<br/><strong>Default value is</strong>:
<code>${commons.release.2.binary.suffix}</code>.</td>
+ <td>The suffix for the alternative release binary
distribution.<br/><strong>Default value is</strong>:
<code>${commons.release.2.binary.suffix}</code>.</td>
</tr>
<tr>
<td><strong><a
href="#commons.release.2.subdir">commons.release.2.subdir</a></strong></td>
@@ -146,7 +154,7 @@
<td><strong><a
href="#commons.release.3.binary.suffix">commons.release.3.binary.suffix</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The suffix for the alternative release binary
distro.<br/><strong>Default value is</strong>:
<code>${commons.release.3.binary.suffix}</code>.</td>
+ <td>The suffix for the alternative release binary
distribution.<br/><strong>Default value is</strong>:
<code>${commons.release.3.binary.suffix}</code>.</td>
</tr>
<tr>
<td><strong><a
href="#commons.release.3.subdir">commons.release.3.subdir</a></strong></td>
@@ -171,7 +179,7 @@
<td><strong><a
href="#commons.release.4.binary.suffix">commons.release.4.binary.suffix</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The suffix for the alternative release binary
distro.<br/><strong>Default value is</strong>:
<code>${commons.release.4.binary.suffix}</code>.</td>
+ <td>The suffix for the alternative release binary
distribution.<br/><strong>Default value is</strong>:
<code>${commons.release.4.binary.suffix}</code>.</td>
</tr>
<tr>
<td><strong><a
href="#commons.release.4.subdir">commons.release.4.subdir</a></strong></td>
@@ -190,25 +198,36 @@
</subsection>
<subsection name="Parameter Details">
<!-- Release (current) -->
- <p><strong><a
name="commons.release.version">commons.release.version</a>:</strong></p>
+ <p>
+ <strong><a
name="commons.release.version">commons.release.version</a>:</strong>
+ </p>
<div>The version of the latest release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.release.version}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.name">commons.release.name</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.name">commons.release.name</a>:</strong>
+ </p>
<div>The name of the latest release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.release.name}</code></li>
- </ul><hr/><p><strong><a
name="commons.binary.suffix">commons.binary.suffix</a>:</strong></p>
- <div>The suffix for the binary distro.</div>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.binary.suffix">commons.binary.suffix</a>:</strong>
+ </p>
+ <div>The suffix for the binary distribution.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.binary.suffix}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.desc">commons.release.desc</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.desc">commons.release.desc</a>:</strong>
+ </p>
<div>Release Title or Description.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -216,84 +235,123 @@
<li><strong>Default</strong>:
<code>${commons.release.desc}</code></li>
</ul><hr/>
<!-- Release 2 -->
- <p><strong><a
name="commons.release.2.version">commons.release.2.version</a>:</strong></p>
+ <p>
+ <strong><a
name="commons.release.2.version">commons.release.2.version</a>:</strong>
+ </p>
<div>The version of an alternative release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.2.version}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.2.name">commons.release.2.name</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.2.name">commons.release.2.name</a>:</strong>
+ </p>
<div>The name of the alternative release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.release.2.name}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.2.desc">commons.release.2.desc</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.2.desc">commons.release.2.desc</a>:</strong>
+ </p>
<div>Alternative Release Title or Description.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.2.desc}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.2.binary.suffix">commons.release.2.binary.suffix</a>:</strong></p>
- <div>The suffix for the alternative release binary distro.</div>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.2.binary.suffix">commons.release.2.binary.suffix</a>:</strong>
+ </p>
+ <div>The suffix for the alternative release binary distribution.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.2.binary.suffix}</code></li>
</ul><hr/><hr/>
<!-- Release 3 -->
- <p><strong><a
name="commons.release.3.version">commons.release.3.version</a>:</strong></p>
+ <p>
+ <strong><a
name="commons.release.3.version">commons.release.3.version</a>:</strong>
+ </p>
<div>The version of an alternative release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.3.version}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.3.name">commons.release.3.name</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.3.name">commons.release.3.name</a>:</strong>
+ </p>
<div>The name of the alternative release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.release.3.name}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.3.desc">commons.release.3.desc</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.3.desc">commons.release.3.desc</a>:</strong>
+ </p>
<div>Alternative Release Title or Description.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.3.desc}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.3.binary.suffix">commons.release.3.binary.suffix</a>:</strong></p>
- <div>The suffix for the alternative release binary distro.</div>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.3.binary.suffix">commons.release.3.binary.suffix</a>:</strong>
+ </p>
+ <div>The suffix for the alternative release binary distribution.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.3.binary.suffix}</code></li>
- </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<!-- Release 4 -->
- <p><strong><a
name="commons.release.4.version">commons.release.4.version</a>:</strong></p>
+ <p>
+ <strong><a
name="commons.release.4.version">commons.release.4.version</a>:</strong>
+ </p>
<div>The version of an alternative release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.4.version}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.4.name">commons.release.4.name</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.4.name">commons.release.4.name</a>:</strong>
+ </p>
<div>The name of the alternative release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.release.4.name}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.4.desc">commons.release.4.desc</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.4.desc">commons.release.4.desc</a>:</strong>
+ </p>
<div>Alternative Release Title or Description.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.4.desc}</code></li>
- </ul><hr/><p><strong><a
name="commons.release.4.binary.suffix">commons.release.4.binary.suffix</a>:</strong></p>
- <div>The suffix for the alternative release binary distro.</div>
+ </ul><hr/>
+ <p>
+ <strong><a
name="commons.release.4.binary.suffix">commons.release.4.binary.suffix</a>:</strong>
+ </p>
+ <div>The suffix for the alternative release binary distribution.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>:
<code>${commons.release.4.binary.suffix}</code></li>
- </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<!-- End of Releases -->
<ul>
@@ -301,7 +359,10 @@
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/download-page.xml b/src/site/xdoc/download-page.xml
index 9f8003c..f8533cb 100644
--- a/src/site/xdoc/download-page.xml
+++ b/src/site/xdoc/download-page.xml
@@ -59,7 +59,7 @@
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=blob;f=src/main/resources/commons-xdoc-templates/no-download-page-template.xml";>no-download-page-template.xml</a>
template, depending on whether the
<code>commons.release.version</code> property is set or not.
</li>
- <li>Uses the <a href="download-page-mojo.html">goal's
(i.e., mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="download-page-mojo.html">goal's
(mojo's) parameters</a> to filter values in the template</li>
</ul>
</subsection>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 6e50c51..06ecb97 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -70,9 +70,13 @@
</p>
<source>mvn commons:download-page
[-Dcommons.release.version=1.2.3]</source>
- <p>As noted above, you can override POM properties if
necessary.</p>
+ <p>
+ As noted above, you can override POM properties if necessary.
+ </p>
- <p>To use a SNAPSHOT version (for testing, etc.):</p>
+ <p>
+ To use a SNAPSHOT version (for testing and so on):
+ </p>
<source>mvn
org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page
[-Dcommons.release.version=1.2.3]</source>
</section>
</body>
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index 234748d..491d65e 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -58,13 +58,13 @@ limitations under the License.
<p>
To use JIRA, you may need to <a
href="https://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
- (if you have previously created/updated Commons issues using Bugzilla,
an account will have been automatically
+ (if you have previously created or updated Commons issues using
Bugzilla, an account will have been automatically
created and you can use the <a
href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
page to get a new password).
</p>
<p>
- If you would like to report a bug, or raise an enhancement request with
+ If you would like to report a bug or request an enhancement for
Apache Commons Build Plugin Maven Mojo, please do the following:
</p>
<ol>
diff --git a/src/site/xdoc/jira-page-mojo.xml b/src/site/xdoc/jira-page-mojo.xml
index be56637..8738833 100644
--- a/src/site/xdoc/jira-page-mojo.xml
+++ b/src/site/xdoc/jira-page-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:jira-page">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:jira-page</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:jira-page
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate Issue Tracking page</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -77,26 +85,37 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a name="commons.jira.id">commons.jira.id</a>:</strong></p>
+ <p>
+ <strong><a name="commons.jira.id">commons.jira.id</a>:</strong>
+ </p>
<div>The external JIRA ID for the project (alphabetic, uppercase)</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>${commons.jira.id}</code></li>
- </ul><hr/><p><strong><a
name="commons.jira.pid">commons.jira.pid</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="commons.jira.pid">commons.jira.pid</a>:</strong>
+ </p>
<div>The internal JIRA ID for the project (numeric)</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>${commons.jira.pid}</code></li>
- </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/jira-page.xml b/src/site/xdoc/jira-page.xml
index 48ded32..75dc783 100644
--- a/src/site/xdoc/jira-page.xml
+++ b/src/site/xdoc/jira-page.xml
@@ -50,13 +50,13 @@
Ant script</li>
<li>Uses the <a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/issue-tracking-template.xml";>issue-tracking-template.xml</a>
template</li>
- <li>Uses the <a href="jira-page-mojo.html">goal's (i.e.,
mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="jira-page-mojo.html">goal's (mojo's)
parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a JIRA page, the following <a
href="jira-page-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
+ To generate a JIRA page, the following <a
href="jira-page-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
</p>
<ul>
<li><b>commons.jira.id</b> - JIRA's external (uppercase)
project ID for the component</li>
diff --git a/src/site/xdoc/mail-page-mojo.xml b/src/site/xdoc/mail-page-mojo.xml
index c5e0e4e..ed397ea 100644
--- a/src/site/xdoc/mail-page-mojo.xml
+++ b/src/site/xdoc/mail-page-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:mail-page">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:mail-page</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:mail-page
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate Mailing List page</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -65,14 +73,19 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a name="basedir">basedir</a>:</strong></p>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/mail-page.xml b/src/site/xdoc/mail-page.xml
index 4a45b86..1d2204f 100644
--- a/src/site/xdoc/mail-page.xml
+++ b/src/site/xdoc/mail-page.xml
@@ -50,13 +50,13 @@
Ant script</li>
<li>Uses the <a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/mail-lists-template.xml";>mail-lists-template.xml</a>
template</li>
- <li>Uses the <a href="mail-page-mojo.html">goal's (i.e.,
mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="mail-page-mojo.html">goal's (mojo's)
parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a Mailing List page, the following <a
href="mail-page-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
+ To generate a Mailing List page, the following <a
href="mail-page-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
</p>
<ul>
<li><b>commons.componentid</b> - Commons component ID</li>
diff --git a/src/site/xdoc/notice-txt-mojo.xml
b/src/site/xdoc/notice-txt-mojo.xml
index 1b5d3f0..a816649 100644
--- a/src/site/xdoc/notice-txt-mojo.xml
+++ b/src/site/xdoc/notice-txt-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:notice-txt">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:notice-txt</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:notice-txt
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate NOTICE.txt</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -44,7 +52,7 @@
<td><strong><a
href="#project.inceptionYear">project.inceptionYear</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The year of the project's inception, specified with 4 digits.
This value is used when generating copyright notices as well as being
informational.<br/><strong>Default value is</strong>:
<code>${project.inceptionYear}</code>.</td>
+ <td>The year of the project's inception, specified as four digits.
This value provides project information and is used to generate copyright
notices.<br/><strong>Default value is</strong>:
<code>${project.inceptionYear}</code>.</td>
</tr>
<tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
@@ -71,20 +79,28 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a
name="commons.release.version">project.inceptionYear</a>:</strong></p>
- <div>The year of the project's inception, specified with 4 digits.
This value is used when generating copyright notices as well as being
informational.</div>
+ <p>
+ <strong><a
name="commons.release.version">project.inceptionYear</a>:</strong>
+ </p>
+ <div>The year of the project's inception, specified as four digits.
This value provides project information and is used to generate copyright
notices.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${project.inceptionYear}</code></li>
- </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/notice-txt.xml b/src/site/xdoc/notice-txt.xml
index 307c4b7..3771c3c 100644
--- a/src/site/xdoc/notice-txt.xml
+++ b/src/site/xdoc/notice-txt.xml
@@ -30,13 +30,12 @@
<subsection name="Overview">
<p>
- The <code>commons-build:notice-txt</code> goal generates a
README.md file for a component.
+ The <code>commons-build:notice-txt</code> goal generates a
NOTICE.txt file for a component.
Execute the goal using the following command: <source>mvn
commons-build:notice-txt</source>
</p>
<p>
- <strong>Note:</strong> The README.md should be regenerated
after every release of the
- component since it contains the Maven coordinates of the
latest release.
+ <strong>Note:</strong> Regenerate NOTICE.txt when the project
name or copyright years change.
</p>
<p>
@@ -50,16 +49,16 @@
Ant script</li>
<li>Uses the <a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/notice-txt-template.txt";>notice-txt-template.txt</a>
template</li>
- <li>Uses the <a href="notice-txt-mojo.html">goal's (i.e.,
mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="notice-txt-mojo.html">goal's
(mojo's) parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a README.md, the following <a
href="notice-txt-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
+ To generate a NOTICE.txt file, the following <a
href="notice-txt-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
</p>
<ul>
- <li><b>project.inceptionYear</b> - The year of the
project's inception, specified with 4 digits. This value is used when
generating copyright notices as well as being informational.</li>
+ <li><b>project.inceptionYear</b> - The year of the
project's inception, specified as four digits. This value provides project
information and is used to generate copyright notices.</li>
</ul>
<p>
Example configuration for Commons Text:
diff --git a/src/site/xdoc/readme-md-mojo.xml b/src/site/xdoc/readme-md-mojo.xml
index 682e769..10eed64 100644
--- a/src/site/xdoc/readme-md-mojo.xml
+++ b/src/site/xdoc/readme-md-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:readme-md">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:readme-md</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:readme-md
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate README.md</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -77,26 +85,37 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a
name="commons.release.version">commons.release.version</a>:</strong></p>
+ <p>
+ <strong><a
name="commons.release.version">commons.release.version</a>:</strong>
+ </p>
<div>The version of the latest release of the project.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.release.version}</code></li>
- </ul><hr/><p><strong><a
name="commons.componentid">commons.componentid</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="commons.componentid">commons.componentid</a>:</strong>
+ </p>
<div>The Commons component ID.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.componentid}</code></li>
- </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/readme-md.xml b/src/site/xdoc/readme-md.xml
index ecc612e..994800b 100644
--- a/src/site/xdoc/readme-md.xml
+++ b/src/site/xdoc/readme-md.xml
@@ -50,13 +50,13 @@
Ant script</li>
<li>Uses the <a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/readme-md-template.md";>readme-md-template.md</a>
template</li>
- <li>Uses the <a href="readme-md-mojo.html">goal's (i.e.,
mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="readme-md-mojo.html">goal's (mojo's)
parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a README.md file, the following <a
href="readme-md-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
+ To generate a README.md file, the following <a
href="readme-md-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>.
</p>
<ul>
<li><b>commons.componentid</b> - Commons component ID</li>
diff --git a/src/site/xdoc/sandbox-jira-page-mojo.xml
b/src/site/xdoc/sandbox-jira-page-mojo.xml
index d7f6bd8..9f2f3bd 100644
--- a/src/site/xdoc/sandbox-jira-page-mojo.xml
+++ b/src/site/xdoc/sandbox-jira-page-mojo.xml
@@ -23,11 +23,19 @@
</properties>
<body>
<section name="commons-build:sandbox-jira-page">
- <p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.11:sandbox-jira-page</p>
- <p><strong>Description</strong>:</p>
+ <p>
+ <strong>Full name</strong>:
+ </p>
+ <p>
+ org.apache.commons:commons-build-plugin:1.11:sandbox-jira-page
+ </p>
+ <p>
+ <strong>Description</strong>:
+ </p>
<div>Apache Commons Build Mojo: Generate Sandbox Issue Tracking
page</div>
- <p><strong>Attributes</strong>:</p>
+ <p>
+ <strong>Attributes</strong>:
+ </p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
<li>Is NOT inherited by default in multi-project builds.</li>
@@ -71,20 +79,28 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a
name="commons.jira.componentid">commons.jira.componentid</a>:</strong></p>
+ <p>
+ <strong><a
name="commons.jira.componentid">commons.jira.componentid</a>:</strong>
+ </p>
<div>The internal JIRA component ID (numeric)</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>:
<code>${commons.jira.componentid}</code></li>
- </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="basedir">basedir</a>:</strong>
+ </p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${antBasedir}</code></li>
<li><strong>Default</strong>: <code>${basedir}</code></li>
- </ul><hr/><p><strong><a
name="messageLevel">messageLevel</a>:</strong></p>
+ </ul><hr/>
+ <p>
+ <strong><a name="messageLevel">messageLevel</a>:</strong>
+ </p>
<div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
diff --git a/src/site/xdoc/sandbox-jira-page.xml
b/src/site/xdoc/sandbox-jira-page.xml
index a20f152..f43d0e2 100644
--- a/src/site/xdoc/sandbox-jira-page.xml
+++ b/src/site/xdoc/sandbox-jira-page.xml
@@ -50,13 +50,13 @@
Ant script</li>
<li>Uses the <a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml";>sandbox-issue-tracking-template.xml</a>
template</li>
- <li>Uses the <a href="sandbox-jira-page-mojo.html">goal's
(i.e., mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="sandbox-jira-page-mojo.html">goal's
(mojo's) parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a JIRA page, the following <a
href="sandbox-jira-page-mojo.html">properties</a> are configured in the
component's <code>pom.xml</code>.
+ To generate a JIRA page, the following <a
href="sandbox-jira-page-mojo.html">properties</a> are configured in the
component's <code>pom.xml</code>.
</p>
<ul>
<li><b>commons.jira.componentid</b> - JIRA's internal
(numeric) ID for the component</li>
