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 ff0457a Site documentation and comments.
ff0457a is described below
commit ff0457a4f5f877394a759342d4c7a885da6e9487
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Sep 15 07:42:21 2026 -0700
Site documentation and comments.
---
CONTRIBUTING.md | 20 +++---
README.md | 4 +-
.../contributing-md-template.md | 20 +++---
.../commons-xdoc-templates/download-page-head.xml | 2 +-
.../issue-tracking-template.xml | 10 +--
.../commons-xdoc-templates/readme-md-template.md | 4 +-
.../sandbox-issue-tracking-template.xml | 10 +--
src/main/scripts/generate-xdocs.mojos.xml | 78 +++++++++++-----------
src/site/xdoc/all-sandbox.xml | 8 +--
src/site/xdoc/all.xml | 8 +--
src/site/xdoc/contributing-md-mojo.xml | 8 +--
src/site/xdoc/contributing-md.xml | 12 ++--
src/site/xdoc/copy-javadoc-files-build.xml | 4 +-
src/site/xdoc/copy-javadoc-files-mojo.xml | 4 +-
src/site/xdoc/development.xml | 22 +++---
src/site/xdoc/download-page-mojo.xml | 4 +-
src/site/xdoc/download-page.xml | 24 +++----
src/site/xdoc/download_build-plugin.xml | 2 +-
src/site/xdoc/index.xml | 4 +-
src/site/xdoc/issue-tracking.xml | 10 +--
src/site/xdoc/jira-page-mojo.xml | 12 ++--
src/site/xdoc/jira-page.xml | 14 ++--
src/site/xdoc/mail-page-mojo.xml | 4 +-
src/site/xdoc/mail-page.xml | 12 ++--
src/site/xdoc/notice-txt-mojo.xml | 4 +-
src/site/xdoc/notice-txt.xml | 10 +--
src/site/xdoc/readme-md-mojo.xml | 8 +--
src/site/xdoc/readme-md.xml | 10 +--
src/site/xdoc/sandbox-jira-page-mojo.xml | 8 +--
src/site/xdoc/sandbox-jira-page.xml | 14 ++--
30 files changed, 177 insertions(+), 177 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e3f8d99..1de2dcc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,17 +41,17 @@
Contributing to Apache Commons Build Plugin Maven Mojo
======================
-Have you found a bug or have an idea for a cool new feature? Contributing code
is a great way to give something back to the open-source community.
-Before you dig right into the code, we need contributors to follow a few
guidelines to have a chance of keeping on top of things.
+Have you found a bug, or do you have an idea for a cool new feature?
Contributing code is a great way to give something back to the open-source
community.
+Before you dig right into the code, please review these guidelines to help us
manage contributions.
Getting Started
---------------
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
-+ Make sure you have a [GitHub account](https://github.com/signup). This is
not essential, but makes providing patches much easier.
-+ If you're planning to implement a new feature it makes sense to discuss your
changes on the [dev list](https://commons.apache.org/mail-lists.html) first.
This way you can make sure you're not wasting your time on something that isn't
considered to be in Apache Commons Build Plugin Maven Mojo's scope.
++ Make sure you have a [GitHub account](https://github.com/signup). This is
not essential, but it makes providing patches much easier.
++ If you're planning to implement a new feature, it makes sense to discuss
your changes on the [dev list](https://commons.apache.org/mail-lists.html)
first. This way you can make sure you're not wasting your time on something
that isn't considered to be in Apache Commons Build Plugin Maven Mojo's scope.
+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already
exist.
- + Clearly describe the issue including steps to reproduce when it is a bug.
+ + Clearly describe the issue, including steps to reproduce it if it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
+ Find the corresponding [repository on
GitHub](https://github.com/apache/?query=commons-),
[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
and check out your forked repository. If you don't have a GitHub account, you
can still clone the Commons repository.
@@ -60,16 +60,16 @@ Making Changes
--------------
+ Create a _topic branch_ for your isolated work.
- * Usually you should base your branch from the `master` branch.
- * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`COMMONSSITE-123-InputStream`.
+ * 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`.
* 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.
* For example, `[COMMONSSITE-123] Close input stream sooner`
+ Respect the original code style:
+ Only use spaces for indentation; you can check for unnecessary whitespace
with `git diff` before committing.
- + Create minimal diffs - disable _On Save_ actions like _Reformat Source
Code_ or _Organize Imports_. If you feel the source code should be reformatted
create a separate PR for this change first.
-+ Write unit tests that match behavioral changes, where the tests fail if the
changes to the runtime are not applied. This may not always be possible but is
a best practice.
+ + Create minimal diffs: disable _On Save_ actions like _Reformat Source
Code_ or _Organize Imports_. If you feel the source code should be reformatted,
create a separate PR for this change first.
++ Write unit tests that match behavioral changes, where the tests fail if the
changes to the runtime are not applied. This may not always be possible, but it
is a best practice.
Unit tests are typically in the `src/test/java` directory.
+ Run a successful build using the default [Maven](https://maven.apache.org/)
goal with `mvn`; that's `mvn` on the command line by itself.
+ Write a pull request description that is detailed enough to understand what
the pull request does, how, and why.
@@ -95,7 +95,7 @@ Submitting Changes
+ Push your changes to a topic branch in your fork of the repository.
+ Submit a _Pull Request_ to the corresponding repository in the `apache`
organization.
* Verify _Files Changed_ shows only your intended changes and does not
- include additional files like `target/*.class`
+ include additional files like `target/*.class`.
+ Update your JIRA ticket and include a link to the pull request in the ticket.
If you prefer to not use GitHub, then you can instead use
diff --git a/README.md b/README.md
index 50955a4..bd7a675 100644
--- a/README.md
+++ b/README.md
@@ -89,11 +89,11 @@ From a command shell, run `mvn` without arguments to invoke
the default Maven go
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) is the main channel of
communication for contributors.
+We accept pull requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) is the main channel of
communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the existing code style for each file.
-+ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Create minimal diffs: disable on-save actions like reformatting source code
or organizing imports. If you feel the source code should be reformatted,
create a separate PR for this change.
+ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running `mvn`.
+ Before you push a PR, run `mvn` (without arguments). This runs the default
goal which contains all build checks.
+ To see the code coverage report, regardless of coverage failures, run `mvn
clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
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 906ff68..dc1d5fc 100644
--- a/src/main/resources/commons-xdoc-templates/contributing-md-template.md
+++ b/src/main/resources/commons-xdoc-templates/contributing-md-template.md
@@ -41,17 +41,17 @@
Contributing to @NAME@
======================
-Have you found a bug or have an idea for a cool new feature? Contributing code
is a great way to give something back to the open-source community.
-Before you dig right into the code, we need contributors to follow a few
guidelines to have a chance of keeping on top of things.
+Have you found a bug, or do you have an idea for a cool new feature?
Contributing code is a great way to give something back to the open-source
community.
+Before you dig right into the code, please review these guidelines to help us
manage contributions.
Getting Started
---------------
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
-+ Make sure you have a [GitHub account](https://github.com/signup). This is
not essential, but makes providing patches much easier.
-+ If you're planning to implement a new feature it makes sense to discuss your
changes on the [dev list](https://commons.apache.org/mail-lists.html) first.
This way you can make sure you're not wasting your time on something that isn't
considered to be in @NAME@'s scope.
++ Make sure you have a [GitHub account](https://github.com/signup). This is
not essential, but it makes providing patches much easier.
++ If you're planning to implement a new feature, it makes sense to discuss
your changes on the [dev list](https://commons.apache.org/mail-lists.html)
first. This way you can make sure you're not wasting your time on something
that isn't considered to be in @NAME@'s scope.
+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already
exist.
- + Clearly describe the issue including steps to reproduce when it is a bug.
+ + Clearly describe the issue, including steps to reproduce it if it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
+ Find the corresponding [repository on
GitHub](https://github.com/apache/?query=commons-),
[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
and check out your forked repository. If you don't have a GitHub account, you
can still clone the Commons repository.
@@ -60,16 +60,16 @@ Making Changes
--------------
+ Create a _topic branch_ for your isolated work.
- * Usually you should base your branch from the `master` branch.
- * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`@JIRA_ID@-123-InputStream`.
+ * 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`.
* 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.
* For example, `[@JIRA_ID@-123] Close input stream sooner`
+ Respect the original code style:
+ Only use spaces for indentation; you can check for unnecessary whitespace
with `git diff` before committing.
- + Create minimal diffs - disable _On Save_ actions like _Reformat Source
Code_ or _Organize Imports_. If you feel the source code should be reformatted
create a separate PR for this change first.
-+ Write unit tests that match behavioral changes, where the tests fail if the
changes to the runtime are not applied. This may not always be possible but is
a best practice.
+ + Create minimal diffs: disable _On Save_ actions like _Reformat Source
Code_ or _Organize Imports_. If you feel the source code should be reformatted,
create a separate PR for this change first.
++ Write unit tests that match behavioral changes, where the tests fail if the
changes to the runtime are not applied. This may not always be possible, but it
is a best practice.
Unit tests are typically in the `src/test/java` directory.
+ Run a successful build using the default [Maven](https://maven.apache.org/)
goal with `mvn`; that's `mvn` on the command line by itself.
+ Write a pull request description that is detailed enough to understand what
the pull request does, how, and why.
@@ -95,7 +95,7 @@ Submitting Changes
+ Push your changes to a topic branch in your fork of the repository.
+ Submit a _Pull Request_ to the corresponding repository in the `apache`
organization.
* Verify _Files Changed_ shows only your intended changes and does not
- include additional files like `target/*.class`
+ include additional files like `target/*.class`.
+ Update your JIRA ticket and include a link to the pull request in the ticket.
If you prefer to not use GitHub, then you can instead use
diff --git a/src/main/resources/commons-xdoc-templates/download-page-head.xml
b/src/main/resources/commons-xdoc-templates/download-page-head.xml
index 7b2e41e..fed8026 100644
--- a/src/main/resources/commons-xdoc-templates/download-page-head.xml
+++ b/src/main/resources/commons-xdoc-templates/download-page-head.xml
@@ -106,7 +106,7 @@ limitations under the License.
It is essential that you
<a href="https://www.apache.org/info/verification.html";>verify the
integrity</a>
of downloaded files, preferably using the <code>PGP</code> signature
(<code>*.asc</code> files);
- failing that using the <code>@HASHUC@</code> hash
(<code>*.@HASHLC@</code> checksum files).
+ failing that, using the <code>@HASHUC@</code> hash
(<code>*.@HASHLC@</code> checksum files).
</p>
<p>
The <a href="https://downloads.apache.org/commons/KEYS";>KEYS</a>
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 1b9e4ea..6d15d41 100644
--- a/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
+++ b/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
@@ -57,19 +57,19 @@ limitations under the License.
</p>
<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
+ 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
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
- @NAME@ please do the following:
+ @NAME@, please do the following:
</p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=@JIRA_PID@&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
- If you find your issue listed then please add a comment with your
details.</li>
+ If you find your issue listed, then please add a comment with your
details.</li>
<li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
You may find your issue or idea has already been discussed.</li>
<li>Decide if your issue is a bug or an enhancement.</li>
@@ -87,7 +87,7 @@ limitations under the License.
</ul>
<p>
- For more information on creating patches see the
+ For more information on creating patches, see the
<a href="https://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
</p>
diff --git a/src/main/resources/commons-xdoc-templates/readme-md-template.md
b/src/main/resources/commons-xdoc-templates/readme-md-template.md
index 2d3c167..9cabe37 100644
--- a/src/main/resources/commons-xdoc-templates/readme-md-template.md
+++ b/src/main/resources/commons-xdoc-templates/readme-md-template.md
@@ -83,11 +83,11 @@ From a command shell, run `mvn` without arguments to invoke
the default Maven go
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) is the main channel of
communication for contributors.
+We accept pull requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) is the main channel of
communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the existing code style for each file.
-+ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Create minimal diffs: disable on-save actions like reformatting source code
or organizing imports. If you feel the source code should be reformatted,
create a separate PR for this change.
+ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running `mvn`.
+ Before you push a PR, run `mvn` (without arguments). This runs the default
goal which contains all build checks.
+ To see the code coverage report, regardless of coverage failures, run `mvn
clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
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 ed84140..c4df80b 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
@@ -55,19 +55,19 @@ limitations under the License.
</p>
<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
+ 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
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
- @NAME@ please do the following:
+ @NAME@, please do the following:
</p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=@JIRA_COMPONENTID@&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
- If you find your issue listed then please add a comment with your
details.</li>
+ If you find your issue listed, then please add a comment with your
details.</li>
<li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
You may find your issue or idea has already been discussed.</li>
<li>Decide if your issue is a bug or an enhancement.</li>
@@ -85,7 +85,7 @@ limitations under the License.
</ul>
<p>
- For more information on creating patches see the
+ For more information on creating patches, see the
<a href="https://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
</p>
diff --git a/src/main/scripts/generate-xdocs.mojos.xml
b/src/main/scripts/generate-xdocs.mojos.xml
index 9413c2b..eb8260a 100644
--- a/src/main/scripts/generate-xdocs.mojos.xml
+++ b/src/main/scripts/generate-xdocs.mojos.xml
@@ -83,7 +83,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.id}</defaultValue>
<type>java.lang.String</type>
- <description>The external JIRA id for the project
(alphabetic, upper case.)</description>
+ <description>The external JIRA ID for the project
(alphabetic, uppercase).</description>
</parameter>
<parameter>
<name>commons.componentid</name>
@@ -92,7 +92,7 @@
<readonly>true</readonly>
<defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The commons component id.</description>
+ <description>The Commons component ID.</description>
</parameter>
<parameter>
<name>commons.dist.subdir</name>
@@ -110,7 +110,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.pid}</defaultValue>
<type>java.lang.String</type>
- <description>The internal JIRA id for the project
(numeric.)</description>
+ <description>The internal JIRA ID for the project
(numeric).</description>
</parameter>
<parameter>
<name>commons.release.version</name>
@@ -155,7 +155,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.hash</name>
@@ -164,7 +164,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.2.* -->
<parameter>
@@ -210,7 +210,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.2.hash</name>
@@ -219,7 +219,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.3.* -->
<parameter>
@@ -265,7 +265,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.3.hash</name>
@@ -274,7 +274,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.4.* -->
<parameter>
@@ -320,7 +320,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.4.hash</name>
@@ -329,7 +329,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
</parameters>
</mojo>
@@ -373,7 +373,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.id}</defaultValue>
<type>java.lang.String</type>
- <description>The external JIRA id for the project
(alphabetic, upper case.)</description>
+ <description>The external JIRA ID for the project
(alphabetic, uppercase).</description>
</parameter>
<parameter>
<name>commons.componentid</name>
@@ -382,7 +382,7 @@
<readonly>true</readonly>
<defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The commons component id.</description>
+ <description>The Commons component ID.</description>
</parameter>
<parameter>
<name>commons.jira.pid</name>
@@ -391,7 +391,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.pid}</defaultValue>
<type>java.lang.String</type>
- <description>The internal JIRA id for the project
(numeric.)</description>
+ <description>The internal JIRA ID for the project
(numeric).</description>
</parameter>
<parameter>
<name>commons.release.version</name>
@@ -436,7 +436,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.hash</name>
@@ -445,7 +445,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.2.* -->
<parameter>
@@ -491,7 +491,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.2.hash</name>
@@ -500,7 +500,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.3.* -->
<parameter>
@@ -546,7 +546,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.3.hash</name>
@@ -555,7 +555,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.4.* -->
<parameter>
@@ -601,7 +601,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.4.hash</name>
@@ -610,7 +610,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
</parameters>
</mojo>
@@ -636,7 +636,7 @@
<readonly>true</readonly>
<defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The commons component id.</description>
+ <description>The Commons component ID.</description>
</parameter>
</parameters>
</mojo>
@@ -662,7 +662,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.id}</defaultValue>
<type>java.lang.String</type>
- <description>The external JIRA id for the project
(alphabetic, upper case.)</description>
+ <description>The external JIRA ID for the project
(alphabetic, uppercase).</description>
</parameter>
<parameter>
<name>commons.jira.pid</name>
@@ -671,7 +671,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.pid}</defaultValue>
<type>java.lang.String</type>
- <description>The internal JIRA id for the project
(numeric.)</description>
+ <description>The internal JIRA ID for the project
(numeric).</description>
</parameter>
</parameters>
</mojo>
@@ -697,7 +697,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The internal JIRA component id
(numeric.)</description>
+ <description>The internal JIRA component ID
(numeric).</description>
</parameter>
</parameters>
</mojo>
@@ -732,7 +732,7 @@
<readonly>true</readonly>
<defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The commons component id.</description>
+ <description>The Commons component ID.</description>
</parameter>
<parameter>
<name>commons.release.version</name>
@@ -777,7 +777,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.hash</name>
@@ -786,7 +786,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.2.* -->
<parameter>
@@ -832,7 +832,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.2.hash</name>
@@ -841,7 +841,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.2.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.3.* -->
<parameter>
@@ -887,7 +887,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.3.hash</name>
@@ -896,7 +896,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.3.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
<!-- commons.release.4.* -->
<parameter>
@@ -942,7 +942,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.subdir}</defaultValue>
<type>java.lang.String</type>
- <description>Subdirectory (instead of
source/binaries.)</description>
+ <description>Subdirectory (instead of
source/binaries).</description>
</parameter>
<parameter>
<name>commons.release.4.hash</name>
@@ -951,7 +951,7 @@
<readonly>false</readonly>
<defaultValue>${commons.release.4.hash}</defaultValue>
<type>java.lang.String</type>
- <description>Type of hash (lower case, e.g.
sha512)</description>
+ <description>Type of hash (lowercase, e.g.,
sha512)</description>
</parameter>
</parameters>
</mojo>
@@ -1004,7 +1004,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.id}</defaultValue>
<type>java.lang.String</type>
- <description>The external JIRA id for the project
(alphabetic, upper case.)</description>
+ <description>The external JIRA ID for the project
(alphabetic, uppercase).</description>
</parameter>
<parameter>
<name>commons.release.version</name>
@@ -1022,7 +1022,7 @@
<readonly>true</readonly>
<defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The commons component id.</description>
+ <description>The Commons component ID.</description>
</parameter>
</parameters>
</mojo>
@@ -1083,7 +1083,7 @@
<readonly>false</readonly>
<defaultValue>${commons.jira.id}</defaultValue>
<type>java.lang.String</type>
- <description>The external JIRA id for the project
(alphabetic, upper case.)</description>
+ <description>The external JIRA ID for the project
(alphabetic, uppercase).</description>
</parameter>
<parameter>
<name>commons.componentid</name>
@@ -1092,7 +1092,7 @@
<readonly>true</readonly>
<defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
- <description>The commons component id.</description>
+ <description>The Commons component ID.</description>
</parameter>
</parameters>
</mojo>
diff --git a/src/site/xdoc/all-sandbox.xml b/src/site/xdoc/all-sandbox.xml
index d5c164d..5852fba 100644
--- a/src/site/xdoc/all-sandbox.xml
+++ b/src/site/xdoc/all-sandbox.xml
@@ -31,24 +31,24 @@
<subsection name="Overview">
<p>
The <code>commons-build:all-sandbox</code> goal generates all
pages for a <strong>Sandbox</strong> component
- (for <strong>Proper</strong> components use the <a
href="all.html">commons-build:all</a> goal).
+ (for <strong>Proper</strong> components, use the <a
href="all.html">commons-build:all</a> goal).
Execute the goal using the following command: <source>mvn
commons-build:all-sandbox</source>
</p>
<p>
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>all-sandbox</code> Mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>all-sandbox</code> Mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>all-sandbox</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ Ant script</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate all pages, the union of other goal's properties
are configured in the component's <code>pom.xml</code>
+ To generate all pages, configure the combined properties of
the other goals in the component's <code>pom.xml</code>.
</p>
</subsection>
diff --git a/src/site/xdoc/all.xml b/src/site/xdoc/all.xml
index 7061967..d3591e2 100644
--- a/src/site/xdoc/all.xml
+++ b/src/site/xdoc/all.xml
@@ -30,24 +30,24 @@
<subsection name="Overview">
<p>
The <code>commons-build:all</code> goal generates all pages
for a <strong>Proper</strong> component
- (for <strong>Sandbox</strong> components use the <a
href="all-sandbox.html">commons-build:all-sandbox</a> goal).
+ (for <strong>Sandbox</strong> components, use the <a
href="all-sandbox.html">commons-build:all-sandbox</a> goal).
Execute the goal using the following command: <source>mvn
commons-build:all</source>
</p>
<p>
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>all</code> Mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>all</code> Mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>all</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ Ant script</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate all pages, the union of other goal's properties
are configured in the component's <code>pom.xml</code>
+ To generate all pages, configure the combined properties of
the other goals in the component's <code>pom.xml</code>.
</p>
</subsection>
diff --git a/src/site/xdoc/contributing-md-mojo.xml
b/src/site/xdoc/contributing-md-mojo.xml
index d534802..1029458 100644
--- a/src/site/xdoc/contributing-md-mojo.xml
+++ b/src/site/xdoc/contributing-md-mojo.xml
@@ -43,7 +43,7 @@
<td><strong><a
href="#commons.jira.id">commons.jira.id</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The external JIRA id for the project (alphabetic, upper
case)<br/><strong>Default value is</strong>:
<code>${commons.jira.id}</code>.</td>
+ <td>The external JIRA ID for the project (alphabetic,
uppercase)<br/><strong>Default value is</strong>:
<code>${commons.jira.id}</code>.</td>
</tr>
<tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
@@ -65,13 +65,13 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
<subsection name="Parameter Details">
<p><strong><a name="commons.jira.id">commons.jira.id</a>:</strong></p>
- <div>The external JIRA id for the project (alphabetic, upper
case)</div>
+ <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>
@@ -84,7 +84,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/contributing-md.xml
b/src/site/xdoc/contributing-md.xml
index cfcd311..f21a907 100644
--- a/src/site/xdoc/contributing-md.xml
+++ b/src/site/xdoc/contributing-md.xml
@@ -35,30 +35,30 @@
</p>
<p>
- <strong>Note:</strong> The CONTRIBUTING.md only needs to be
generated once or if the template changes.
+ <strong>Note:</strong> The CONTRIBUTING.md file only needs to
be generated initially or when the template changes.
</p>
<p>
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>contributing-md</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>contributing-md</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>contributing-md</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ 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
(i.e., mojo's) parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a CONTRIBUTING.md, the following <a
href="contributing-md-mojo.html">properties</a> are configured in the
component's <code>pom.xml</code>
+ To generate a CONTRIBUTING.md file, the following <a
href="contributing-md-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 (upper case)
project id for the component</li>
+ <li><b>commons.jira.id</b> - JIRA's external (uppercase)
project ID for the component</li>
</ul>
<p>
Example configuration for Commons Text:
diff --git a/src/site/xdoc/copy-javadoc-files-build.xml
b/src/site/xdoc/copy-javadoc-files-build.xml
index 56feed8..76b9cba 100644
--- a/src/site/xdoc/copy-javadoc-files-build.xml
+++ b/src/site/xdoc/copy-javadoc-files-build.xml
@@ -28,10 +28,10 @@
<section name="Copy NOTICE and LICENSE files to javadoc jar">
<p>
- This <i>mojo</i> (or <i>ant build script</i>) currently copies
+ This <i>mojo</i> (or <i>Ant build script</i>) currently copies
the NOTICE and LICENSE files to target/apidocs so that they are
included in the
generated -javadoc.jar. This is currently done in the
commons-parent pom.xml
- using the antrun plugin. Doing it here removes the need to have
ant script in
+ using the antrun plugin. Doing it here removes the need to have an
Ant script in
commons-parent.
</p>
diff --git a/src/site/xdoc/copy-javadoc-files-mojo.xml
b/src/site/xdoc/copy-javadoc-files-mojo.xml
index cba53dd..e7a7330 100644
--- a/src/site/xdoc/copy-javadoc-files-mojo.xml
+++ b/src/site/xdoc/copy-javadoc-files-mojo.xml
@@ -59,7 +59,7 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
@@ -72,7 +72,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/development.xml b/src/site/xdoc/development.xml
index b1c256b..31b68dc 100644
--- a/src/site/xdoc/development.xml
+++ b/src/site/xdoc/development.xml
@@ -40,20 +40,20 @@
<section name="New Ant Scripts">
<p>
- Each ant script requires two files, which have to be named
following the conventions for ant plugins:
+ Each Ant script requires two files, which have to be named
following the conventions for Ant plugins:
</p>
<ul>
- <li>An ant build file
+ <li>An Ant build file
<ul><li>[naming convention:
<i>basename</i><b>.build.xml</b>]</li></ul>
</li>
- <li>A <i>mapping document</i> which wires the build file into
maven's plugin framework
+ <li>A <i>mapping document</i> which wires the build file into
Maven's plugin framework
<ul><li>[naming convention:
<i>basename</i><b>.mojos.xml</b>]</li></ul>
</li>
</ul>
<p>
- So if you want to add a new <i>foo-bar</i> ant script you would
create a <code>foo-bar.build.xml</code>
- ant script file and <code>foo-bar.mojos.xml</code> mapping
document.
+ If you want to add a new <i>foo-bar</i> Ant script, you would
create a <code>foo-bar.build.xml</code>
+ Ant script file and a <code>foo-bar.mojos.xml</code> mapping
document.
</p>
<p>
@@ -63,11 +63,11 @@
</p>
<p>
- If you want to access variables from the component's
<code>pom.xml</code> in the ant script
+ If you want to access variables from the component's
<code>pom.xml</code> in the Ant script,
then you need to do two things in the <i>mapping document</i>:
</p>
<ul>
- <li>Add the
<code><requiresProject>true</requiresProject></code></li>
+ <li>Add the
<code><requiresProject>true</requiresProject></code> element.</li>
<li>Add <code><parameter></code> elements for each of
the variables you
want to use.</li>
</ul>
@@ -88,8 +88,8 @@
<section name="Modifying Existing Scripts">
<p>
- Not a lot to say about this except, if you need access to
additional variables from the component's
- <code>pom.xml</code> in the ant build script then you will need to
define additional <i>parameters</i>
+ If you need access to additional variables from the component's
+ <code>pom.xml</code> in the Ant build script, define additional
<i>parameters</i>
for these in the associated <i>mapping document</i>.
</p>
@@ -98,8 +98,8 @@
<section name="Debugging">
<p>
- The <i>message level</i> for ant is <i>info</i> by default.
Running the plugin goal using a message
- level of <i>debug</i> can help in discovering problems - for
example:
+ The <i>message level</i> for Ant is <i>info</i> by default.
Running the plugin goal using a message
+ level of <i>debug</i> can help you discover problems. For example:
<source><![CDATA[
mvn commons-build:jira-page -DantMessageLevel=debug
]]></source>
diff --git a/src/site/xdoc/download-page-mojo.xml
b/src/site/xdoc/download-page-mojo.xml
index 267c1c8..a8d7347 100644
--- a/src/site/xdoc/download-page-mojo.xml
+++ b/src/site/xdoc/download-page-mojo.xml
@@ -184,7 +184,7 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
@@ -302,7 +302,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/download-page.xml b/src/site/xdoc/download-page.xml
index 20d770f..9f8003c 100644
--- a/src/site/xdoc/download-page.xml
+++ b/src/site/xdoc/download-page.xml
@@ -35,8 +35,8 @@
<p>
The above command generates an <i>xdoc</i> page named
download_<i>componentid</i><b>.xml</b> in either the <code>xdocs</code>
- or <code>src/site/xdoc</code> directory (depending on which
exists), which should be checked into git.
- This will cause a download_<i>componentid</i><b>.html</b> page
to be generated when the <code>mvn site</code> is run.
+ or <code>src/site/xdoc</code> directory (depending on which
exists), which should be checked into Git.
+ This will cause a download_<i>componentid</i><b>.html</b> page
to be generated when <code>mvn site</code> is run.
Remember to add a <i>Download</i> link to
download_<i>componentid</i><b>.cgi</b> to the maven <code>site.xml</code>.
</p>
@@ -49,32 +49,32 @@
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>download-page</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>download-page</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=blob;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>download-page</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=blob;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ Ant script</li>
<li>Uses either the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=blob;f=src/main/resources/commons-xdoc-templates/download-page-body.xml";>download-page-body.xml</a>
or
<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
(i.e., mojo's) parameters</a> to filter values in the template</li>
</ul>
</subsection>
<subsection name="Configuration">
<p>
- To generate a Download page, the following <a
href="download-page-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>
+ To generate a Download page, the following <a
href="download-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>
+ <li><b>commons.componentid</b> - Commons component ID</li>
<li><b>commons.release.version</b> - The version number of
the latest release of the component</li>
<li><b>commons.release.name</b> - (<i>optional - defaults
to <code>${commons.release.name}</code></i>) The name of the latest release of
the component</li>
- <li><b>commons.release.desc</b> - (<i>optional</i>) The
download links are shown in a section with the component name and release
version - if this parameter is specified then this text is appended</li>
+ <li><b>commons.release.desc</b> - (<i>optional</i>) The
download links are shown in a section with the component name and release
version - if this parameter is specified, then this text is appended</li>
<li><b>commons.binary.suffix</b> - (<i>optional - defaults
to <code>-bin</code></i>) The suffix for the binary release
(some components use "-bin", others have no
suffix)</li>
- <li><b>commons.release.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; it set it will be
used as the directory for both.</li>
+ <li><b>commons.release.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; if set, it will
be used as the directory for both.</li>
</ul>
<p>
Example configuration for Commons Text:
@@ -95,7 +95,7 @@
<li><b>commons.release.2.desc</b> - (<i>optional</i>)
Additional text to append to the section name of the alternative release</li>
<li><b>commons.release.2.binary.suffix</b> - (<i>optional
- defaults to <code>-bin</code></i>) The suffix for the alternative
binary release (some components use "-bin", others
have no suffix)</li>
- <li><b>commons.release.2.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; it set it will be
used as the directory for both.</li>
+ <li><b>commons.release.2.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; if set, it will
be used as the directory for both.</li>
</ul>
<p>
You can have a third version on the download page. This can be
achieved using the following properties:
@@ -106,7 +106,7 @@
<li><b>commons.release.3.desc</b> - (<i>optional</i>)
Additional text to append to the section name of the alternative release</li>
<li><b>commons.release.3.binary.suffix</b> - (<i>optional
- defaults to <code>-bin</code></i>) The suffix for the alternative
binary release (some components use "-bin", others
have no suffix)</li>
- <li><b>commons.release.3.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; it set it will be
used as the directory for both.</li>
+ <li><b>commons.release.3.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; if set, it will
be used as the directory for both.</li>
</ul>
<p>
You can have a fourth version on the download page. This can
be achieved using the following properties:
@@ -117,7 +117,7 @@
<li><b>commons.release.4.desc</b> - (<i>optional</i>)
Additional text to append to the section name of the alternative release</li>
<li><b>commons.release.4.binary.suffix</b> - (<i>optional
- defaults to <code>-bin</code></i>) The suffix for the alternative
binary release (some components use "-bin", others
have no suffix)</li>
- <li><b>commons.release.4.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; it set it will be
used as the directory for both.</li>
+ <li><b>commons.release.4.subdir</b> - The subdirectory to
use. This defaults to using separate source/binaries folders; if set, it will
be used as the directory for both.</li>
</ul>
<p>
Example configuration for Commons DBCP with two releases:
diff --git a/src/site/xdoc/download_build-plugin.xml
b/src/site/xdoc/download_build-plugin.xml
index e5b6112..ba46962 100644
--- a/src/site/xdoc/download_build-plugin.xml
+++ b/src/site/xdoc/download_build-plugin.xml
@@ -106,7 +106,7 @@ limitations under the License.
It is essential that you
<a href="https://www.apache.org/info/verification.html";>verify the
integrity</a>
of downloaded files, preferably using the <code>PGP</code> signature
(<code>*.asc</code> files);
- failing that using the <code>SHA512</code> hash (<code>*.sha512</code>
checksum files).
+ failing that, using the <code>SHA512</code> hash
(<code>*.sha512</code> checksum files).
</p>
<p>
The <a href="https://downloads.apache.org/commons/KEYS";>KEYS</a>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index d825de4..6e50c51 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -42,7 +42,7 @@
Available Goals:
</p>
<ul>
- <li><a href="all.html">commons-build:all</a> - Generate all
pages for the component's latest release (but not sandbox pages.)</li>
+ <li><a href="all.html">commons-build:all</a> - Generate all
pages for the component's latest release (but not sandbox pages).</li>
<li><a href="all-sandbox.html">commons-build:all-sandbox</a> -
Generate all pages for the sandbox component's latest release.</li>
<li><a
href="download-page.html">commons-build:download-page</a> - Generate a Download
page for the component's latest release.</li>
<li><a href="mail-page.html">commons-build:mail-page</a> -
Generate a custom <i>Mailing List</i> page for a component.</li>
@@ -72,7 +72,7 @@
<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, etc.):</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 a9bbfb6..234748d 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -57,19 +57,19 @@ limitations under the License.
</p>
<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
+ 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
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
- Apache Commons Build Plugin Maven Mojo please do the following:
+ Apache Commons Build Plugin Maven Mojo, please do the following:
</p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
- If you find your issue listed then please add a comment with your
details.</li>
+ If you find your issue listed, then please add a comment with your
details.</li>
<li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
You may find your issue or idea has already been discussed.</li>
<li>Decide if your issue is a bug or an enhancement.</li>
@@ -87,7 +87,7 @@ limitations under the License.
</ul>
<p>
- For more information on creating patches see the
+ For more information on creating patches, see the
<a href="https://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
</p>
diff --git a/src/site/xdoc/jira-page-mojo.xml b/src/site/xdoc/jira-page-mojo.xml
index a6646fc..be56637 100644
--- a/src/site/xdoc/jira-page-mojo.xml
+++ b/src/site/xdoc/jira-page-mojo.xml
@@ -44,13 +44,13 @@
<td><strong><a
href="#commons.jira.id">commons.jira.id</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The external JIRA id for the project (alphabetic, upper
case)<br/><strong>Default value is</strong>:
<code>${commons.jira.id}</code>.</td>
+ <td>The external JIRA ID for the project (alphabetic,
uppercase)<br/><strong>Default value is</strong>:
<code>${commons.jira.id}</code>.</td>
</tr>
<tr>
<td><strong><a
href="#commons.jira.pid">commons.jira.pid</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The internal JIRA id for the project
(numeric)<br/><strong>Default value is</strong>:
<code>${commons.jira.pid}</code>.</td>
+ <td>The internal JIRA ID for the project
(numeric)<br/><strong>Default value is</strong>:
<code>${commons.jira.pid}</code>.</td>
</tr>
<tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
@@ -72,19 +72,19 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
<subsection name="Parameter Details">
<p><strong><a name="commons.jira.id">commons.jira.id</a>:</strong></p>
- <div>The external JIRA id for the project (alphabetic, upper
case)</div>
+ <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>
- <div>The internal JIRA id for the project (numeric)</div>
+ <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>
@@ -97,7 +97,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/jira-page.xml b/src/site/xdoc/jira-page.xml
index 54fac9f..48ded32 100644
--- a/src/site/xdoc/jira-page.xml
+++ b/src/site/xdoc/jira-page.xml
@@ -30,7 +30,7 @@
<subsection name="Overview">
<p>
The <code>commons-build:jira-page</code> goal generates a
custom JIRA Issue Tracking page for a <strong>Proper</strong> component
- (for <strong>Sandbox</strong> components use the <a
href="sandbox-jira-page.html">commons-build:sandbox-jira-page</a> goal).
+ (for <strong>Sandbox</strong> components, use the <a
href="sandbox-jira-page.html">commons-build:sandbox-jira-page</a> goal).
Execute the goal using the following command: <source>mvn
commons-build:jira-page</source>
</p>
@@ -43,24 +43,24 @@
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>jira-page</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>jira-page</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>jira-page</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ 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 (i.e.,
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 (upper case)
project id for the component</li>
- <li><b>commons.jira.pid</b> - JIRA's internal (numeric)
project id for the component</li>
+ <li><b>commons.jira.id</b> - JIRA's external (uppercase)
project ID for the component</li>
+ <li><b>commons.jira.pid</b> - JIRA's internal (numeric)
project ID for the component</li>
</ul>
<p>
Example configuration for Commons Text:
diff --git a/src/site/xdoc/mail-page-mojo.xml b/src/site/xdoc/mail-page-mojo.xml
index 202e485..c5e0e4e 100644
--- a/src/site/xdoc/mail-page-mojo.xml
+++ b/src/site/xdoc/mail-page-mojo.xml
@@ -60,7 +60,7 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
@@ -73,7 +73,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/mail-page.xml b/src/site/xdoc/mail-page.xml
index 97fb5b0..4a45b86 100644
--- a/src/site/xdoc/mail-page.xml
+++ b/src/site/xdoc/mail-page.xml
@@ -30,7 +30,7 @@
<subsection name="Overview">
<p>
- The <code>commons-build:mail-page</code> goal generates a
custom Mailing List page for a component
+ The <code>commons-build:mail-page</code> goal generates a
custom Mailing List page for a component.
Execute the goal using the following command: <source>mvn
commons-build:mail-page</source>
</p>
@@ -43,23 +43,23 @@
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>mail-page</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>mail-page</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>mail-page</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ 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 (i.e.,
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>
+ <li><b>commons.componentid</b> - Commons component ID</li>
</ul>
<p>
Example configuration for Commons Text:
diff --git a/src/site/xdoc/notice-txt-mojo.xml
b/src/site/xdoc/notice-txt-mojo.xml
index dcbfb02..1b5d3f0 100644
--- a/src/site/xdoc/notice-txt-mojo.xml
+++ b/src/site/xdoc/notice-txt-mojo.xml
@@ -66,7 +66,7 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
@@ -85,7 +85,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/notice-txt.xml b/src/site/xdoc/notice-txt.xml
index 4cc28dd..307c4b7 100644
--- a/src/site/xdoc/notice-txt.xml
+++ b/src/site/xdoc/notice-txt.xml
@@ -36,27 +36,27 @@
<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.
+ component since it contains the Maven coordinates of the
latest release.
</p>
<p>
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>notice-txt</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>notice-txt</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>notice-txt</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ 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 (i.e.,
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 README.md, 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>
diff --git a/src/site/xdoc/readme-md-mojo.xml b/src/site/xdoc/readme-md-mojo.xml
index 6305f4f..682e769 100644
--- a/src/site/xdoc/readme-md-mojo.xml
+++ b/src/site/xdoc/readme-md-mojo.xml
@@ -50,7 +50,7 @@
<td><strong><a
href="#commons.componentid">commons.componentid</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>Commons component id.<br/><strong>Default value is</strong>:
<code>${commons.componentid}</code>.</td>
+ <td>Commons component ID.<br/><strong>Default value is</strong>:
<code>${commons.componentid}</code>.</td>
</tr>
<tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
@@ -72,7 +72,7 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
@@ -84,7 +84,7 @@
<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>
- <div>The Commons componentid.</div>
+ <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>
@@ -97,7 +97,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/readme-md.xml b/src/site/xdoc/readme-md.xml
index 744e7fe..ecc612e 100644
--- a/src/site/xdoc/readme-md.xml
+++ b/src/site/xdoc/readme-md.xml
@@ -36,27 +36,27 @@
<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.
+ component since it contains the Maven coordinates of the
latest release.
</p>
<p>
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>readme-md</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>readme-md</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>readme-md</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ 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 (i.e.,
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="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 3496bdb..d7f6bd8 100644
--- a/src/site/xdoc/sandbox-jira-page-mojo.xml
+++ b/src/site/xdoc/sandbox-jira-page-mojo.xml
@@ -44,7 +44,7 @@
<td><strong><a
href="#commons.jira.componentid">commons.jira.componentid</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The internal JIRA component id (numeric)<br/><strong>Default
value is</strong>: <code>${commons.jira.componentid}</code>.</td>
+ <td>The internal JIRA component ID (numeric)<br/><strong>Default
value is</strong>: <code>${commons.jira.componentid}</code>.</td>
</tr>
<tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
@@ -66,13 +66,13 @@
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
- <td>The message-level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
+ <td>The message level used to tune the verbosity of Ant
logging.<br/><strong>Default value is</strong>: <code>info</code>.</td>
</tr>
</table>
</subsection>
<subsection name="Parameter Details">
<p><strong><a
name="commons.jira.componentid">commons.jira.componentid</a>:</strong></p>
- <div>The internal JIRA component id (numeric)</div>
+ <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>
@@ -85,7 +85,7 @@
<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>
- <div>The message-level used to tune the verbosity of Ant logging.</div>
+ <div>The message level used to tune the verbosity of Ant logging.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
diff --git a/src/site/xdoc/sandbox-jira-page.xml
b/src/site/xdoc/sandbox-jira-page.xml
index d6a49ed..a20f152 100644
--- a/src/site/xdoc/sandbox-jira-page.xml
+++ b/src/site/xdoc/sandbox-jira-page.xml
@@ -29,8 +29,8 @@
<subsection name="Overview">
<p>
- The <code>commons-build:sandbox-jira-page</code> goal
generates a custom JIRA Issue Tracking page for a <strong>Sandbox</strong>
component.
- (for <strong>Proper</strong> components use the <a
href="jira-page.html">commons-build:jira-page</a> goal).
+ The <code>commons-build:sandbox-jira-page</code> goal
generates a custom JIRA Issue Tracking page for a <strong>Sandbox</strong>
component
+ (for <strong>Proper</strong> components, use the <a
href="jira-page.html">commons-build:jira-page</a> goal).
Execute the goal using the following command: <source>mvn
commons-build:sandbox-jira-page</source>
</p>
@@ -43,23 +43,23 @@
This goal uses the following:
</p>
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>sandbox-jira-page</code> mojo definition in the
+ <li>The goal is mapped to the Ant script/target using the
<code>sandbox-jira-page</code> mojo definition in the
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
<li>Executes the <code>sandbox-jira-page</code> target in
<a
href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
- ant script</li>
+ 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
(i.e., 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>
+ <li><b>commons.jira.componentid</b> - JIRA's internal
(numeric) ID for the component</li>
</ul>
<p>
Example configuration:
