You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ni...@apache.org on 2009/12/08 12:31:01 UTC
svn commit: r888341 - in
/commons/proper/commons-build-plugin/trunk/src/site: ./ resources/ xdoc/
Author: niallp
Date: Tue Dec 8 11:31:00 2009
New Revision: 888341
URL: http://svn.apache.org/viewvc?rev=888341&view=rev
Log:
COMMONSSITE-48 Update documentation for download-page changes and re-organize pages to reflect goals
Added:
commons/proper/commons-build-plugin/trunk/src/site/resources/
commons/proper/commons-build-plugin/trunk/src/site/resources/download-page-2release.jpg (with props)
commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page.xml
- copied, changed from r887867, commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page.xml
- copied, changed from r887867, commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page.xml
- copied, changed from r887867, commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml
Removed:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml
Modified:
commons/proper/commons-build-plugin/trunk/src/site/site.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/copy-javadoc-files-mojo.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page-mojo.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/index.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page-mojo.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page-mojo.xml
Added: commons/proper/commons-build-plugin/trunk/src/site/resources/download-page-2release.jpg
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/resources/download-page-2release.jpg?rev=888341&view=auto
==============================================================================
Binary file - no diff available.
Propchange: commons/proper/commons-build-plugin/trunk/src/site/resources/download-page-2release.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: commons/proper/commons-build-plugin/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/site.xml?rev=888341&r1=888340&r2=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/site.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/site.xml Tue Dec 8 11:31:00 2009
@@ -24,13 +24,19 @@
<body>
<menu name="Build Plugin">
<item name="Overview" href="/index.html"/>
- <item name="Goals" href="/generate-xdocs-build.html">
- <item name="Generate XDOCS" href="/generate-xdocs-build.html">
- <item name="jira-page" href="/generate-xdocs-build.html"/>
- <item name="download-page" href="/generate-xdocs-build.html#commons:download-page"/>
- <item name="sandbox-jira-page" href="/generate-xdocs-build.html#commons:sandbox-jira-page"/>
+ <item name="Download Page" href="/download-page.html">
+ <item name="download-page" href="/download-page.html"/>
+ <item name="properties" href="/download-page-mojo.html"/>
+ </item>
+ <item name="JIRA Page">
+ <item name="Proper" href="/jira-page.html">
+ <item name="jira-page" href="/jira-page.html"/>
+ <item name="properties" href="/jira-page-mojo.html"/>
+ </item>
+ <item name="Sandbox" href="/sandbox-jira-page.html">
+ <item name="sandbox-jira-page" href="/sandbox-jira-page.html"/>
+ <item name="properties" href="/sandbox-jira-page-mojo.html"/>
</item>
- <item name="copy-javadoc-files" href="/copy-javadoc-files-build.html"/>
</item>
<item name="Help" href="/development.html">
<item name="Development" href="/development.html"/>
Modified: commons/proper/commons-build-plugin/trunk/src/site/xdoc/copy-javadoc-files-mojo.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/copy-javadoc-files-mojo.xml?rev=888341&r1=888340&r2=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/copy-javadoc-files-mojo.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/copy-javadoc-files-mojo.xml Tue Dec 8 11:31:00 2009
@@ -21,60 +21,67 @@
-->
<document>
<properties>
- <title>commons-build-plugin - commons:copy-javadoc-files</title>
- </properties>
+ <title>commons:copy-javadoc-files</title>
+ </properties>
<body>
<section name="commons:copy-javadoc-files">
- <p>Commons Build: Copy NOTICE and LICENSE files to -javadoc.jar</p>
- <p><b>Mojo Attributes</b>:<ul>
- <li>Is NOT inherited by default in multi-project builds.</li>
- </ul>
- </p>
+ <p><strong>Full name</strong>:</p>
+ <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT: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>
+ <ul>
+ <li>Is NOT inherited by default in multi-project builds.</li>
+ </ul>
<subsection name="Required Parameters">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#basedir">basedir</a></b></td>
+ <td><strong><a href="#basedir">basedir</a></strong></td>
<td><code>File</code></td>
- <td>The base directory from which to execute the Ant script. Default value is <code>${basedir}</code>.</td>
- </tr>
- </table>
- </subsection>
+ <td><code>-</code></td>
+ <td>The base directory from which to execute the Ant script.<br/><strong>Default value is</strong>: <code>${basedir}</code>.</td>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Optional Parameters">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#messageLevel">messageLevel</a></b></td>
+ <td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
- <td>The message-level used to tune the verbosity of Ant logging. Default value is <code>info</code>.</td>
- </tr>
- </table>
- </subsection>
+ <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>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Parameter Details">
- <p><b><a name="basedir">basedir</a></b></p>
- <p>The base directory from which to execute the Ant script.</p>
+ <p><strong><a name="basedir">basedir</a>:</strong></p>
+ <div>The base directory from which to execute the Ant script.</div>
<ul>
- <li><b>Type</b>: <code>java.io.File</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Expression</b>: <code>${antBasedir}</code></li>
- <li><b>Default</b>: <code>${basedir}</code></li>
- </ul><hr/><p><b><a name="messageLevel">messageLevel</a></b></p>
- <p>The message-level used to tune the verbosity of Ant logging.</p>
+ <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>
+ <div>The message-level used to tune the verbosity of Ant logging.</div>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>No</code></li>
- <li><b>Expression</b>: <code>${antMessageLevel}</code></li>
- <li><b>Default</b>: <code>info</code></li>
- </ul>
- </subsection>
- </section>
- </body>
- </document>
\ No newline at end of file
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>No</code></li>
+ <li><strong>Expression</strong>: <code>${antMessageLevel}</code></li>
+ <li><strong>Default</strong>: <code>info</code></li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Modified: commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page-mojo.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page-mojo.xml?rev=888341&r1=888340&r2=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page-mojo.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page-mojo.xml Tue Dec 8 11:31:00 2009
@@ -21,94 +21,128 @@
-->
<document>
<properties>
- <title>commons-build-plugin - commons:download-page</title>
- </properties>
+ <title>commons:download-page</title>
+ </properties>
<body>
<section name="commons:download-page">
- <p>Commons Build Ant Mojo: Generate Download page</p>
- <p><b>Mojo Attributes</b>:<ul>
- <li>Requires a Maven 2.0 project to execute.</li>
- <li>Is NOT inherited by default in multi-project builds.</li>
- </ul>
- </p>
+ <p><strong>Full name</strong>:</p>
+ <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:download-page</p>
+ <p><strong>Description</strong>:</p>
+ <div>Commons Build Ant Mojo: Generate Download page</div>
+ <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">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#commons.release.version">commons.release.version</a></b></td>
+ <td><strong><a href="#commons.release.version">commons.release.version</a></strong></td>
<td><code>String</code></td>
- <td>The version of the latest release of the project. Default value is <code>${commons.release.version}</code>.</td>
- </tr>
+ <td><code>-</code></td>
+ <td>The version of the latest release of the project.<br/><strong>Default value is</strong>: <code>${commons.release.version}</code>.</td>
+ </tr>
<tr>
- <td><b><a href="#commons.release.name">commons.release.name</a></b></td>
+ <td><strong><a href="#commons.release.desc">commons.release.desc</a></strong></td>
<td><code>String</code></td>
- <td>The final name (i.e. artifactId-version) of the artifacts being built. Default value is <code>${project.artifactId}-${commons.release.version}</code>.</td>
- </tr>
+ <td><code>-</code></td>
+ <td>Release Title or Description.<br/><strong>Default value is</strong>: <code>${commons.release.desc}</code>.</td>
+ </tr>
<tr>
- <td><b><a href="#commons.binary.suffix">commons.binary.suffix</a></b></td>
+ <td><strong><a href="#commons.binary.suffix">commons.binary.suffix</a></strong></td>
<td><code>String</code></td>
- <td>The suffix for the binary distro. Default value is <code>${commons.binary.suffix}</code>.</td>
- </tr>
+ <td><code>-</code></td>
+ <td>The suffix for the binary distro.<br/><strong>Default value is</strong>: <code>${commons.binary.suffix}</code>.</td>
+ </tr>
<tr>
- <td><b><a href="#basedir">basedir</a></b></td>
+ <td><strong><a href="#basedir">basedir</a></strong></td>
<td><code>File</code></td>
- <td>The base directory from which to execute the Ant script. Default value is <code>${basedir}</code>.</td>
- </tr>
- </table>
- </subsection>
+ <td><code>-</code></td>
+ <td>The base directory from which to execute the Ant script.<br/><strong>Default value is</strong>: <code>${basedir}</code>.</td>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Optional Parameters">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#messageLevel">messageLevel</a></b></td>
+ <td><strong><a href="#commons.release.version.2">commons.release.version.2</a></strong></td>
<td><code>String</code></td>
- <td>The message-level used to tune the verbosity of Ant logging. Default value is <code>info</code>.</td>
- </tr>
- </table>
- </subsection>
+ <td><code>-</code></td>
+ <td>The version of an alternative release of the project.<br/><strong>Default value is</strong>: <code>${commons.release.version.2}</code>.</td>
+ </tr>
+ <tr>
+ <td><strong><a href="#commons.release.desc.2">commons.release.desc.2</a></strong></td>
+ <td><code>String</code></td>
+ <td><code>-</code></td>
+ <td>Alternative Release Title or Description.<br/><strong>Default value is</strong>: <code>${commons.release.desc.2}</code>.</td>
+ </tr>
+ <tr>
+ <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>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Parameter Details">
- <p><b><a name="commons.release.version">commons.release.version</a></b></p>
- <p>The version of the latest release of the project.</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.desc">commons.release.desc</a>:</strong></p>
+ <div>Release Title or Description.</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.desc}</code></li>
+ </ul><hr/><p><strong><a name="commons.release.version.2">commons.release.version.2</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.version.2}</code></li>
+ </ul><hr/><p><strong><a name="commons.release.desc.2">commons.release.desc.2</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.desc.2}</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>
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>Yes</code></li>
+ <li><strong>Default</strong>: <code>${commons.binary.suffix}</code></li>
+ </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>
+ <div>The message-level used to tune the verbosity of Ant logging.</div>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Default</b>: <code>${commons.release.version}</code></li>
- </ul><hr/><p><b><a name="commons.release.name">commons.release.name</a></b></p>
- <p>The final name (i.e. artifactId-version) of the artifacts being built.</p>
- <ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Default</b>: <code>${project.artifactId}-${commons.release.version}</code></li>
- </ul><hr/><p><b><a name="commons.binary.suffix">commons.binary.suffix</a></b></p>
- <p>The suffix for the binary distro.</p>
- <ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Default</b>: <code>${commons.binary.suffix}</code></li>
- </ul><hr/><p><b><a name="basedir">basedir</a></b></p>
- <p>The base directory from which to execute the Ant script.</p>
- <ul>
- <li><b>Type</b>: <code>java.io.File</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Expression</b>: <code>${antBasedir}</code></li>
- <li><b>Default</b>: <code>${basedir}</code></li>
- </ul><hr/><p><b><a name="messageLevel">messageLevel</a></b></p>
- <p>The message-level used to tune the verbosity of Ant logging.</p>
- <ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>No</code></li>
- <li><b>Expression</b>: <code>${antMessageLevel}</code></li>
- <li><b>Default</b>: <code>info</code></li>
- </ul>
- </subsection>
- </section>
- </body>
- </document>
\ No newline at end of file
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>No</code></li>
+ <li><strong>Expression</strong>: <code>${antMessageLevel}</code></li>
+ <li><strong>Default</strong>: <code>info</code></li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Copied: commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page.xml (from r887867, commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml)
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page.xml?p2=commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page.xml&p1=commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml&r1=887867&r2=888341&rev=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/download-page.xml Tue Dec 8 11:31:00 2009
@@ -22,88 +22,13 @@
<document>
<properties>
- <title>Generating XDOC files</title>
+ <title>Generating Download Page</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
- <section name="Generating XDOC files">
- <p>
- The <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">
- generate-xdocs.build.xml</a> Ant build script contains targets for the following goals:
- <ul>
- <li><a href="#commons:jira-page">commons:jira-page</a> - Generate a JIRA Issue Tracking page for a component</li>
- <li><a href="#commons:download-page">commons:download-page</a> - Generate a Download page for a component's latest release</li>
- <li><a href="#commons:sandbox-jira-page">commons:sandbox-jira-page</a> - Generate a JIRA Issue Tracking page for a Sandbox component</li>
- </ul>
- </p>
-
- <p>
- This script generates custom xdoc pages for Commons components using
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/">templates</a>
- and <a href="http://ant.apache.org/manual/CoreTasks/filter.html">Ant's filtering</a> functionality:
- </p>
-
- <p>
- These goals (re-)generate xdoc files in either the default m1 location (i.e. <code>xdocs</code>) or the default m2 location
- (i.e. <code>src/site/xdoc</code>). Once generated these can be checked into svn and the component's site regenerated using <code>mvn site</code>.
- </p>
-
- </section>
-
-
- <section name="commons:jira-page" href="jira-page">
-
- <subsection name="Overview">
- <p>
- The <code>commons:jira-page</code> goal generates a custom JIRA Issue Tracking page for a component.
- Execute the goal using the following command: <source>mvn commons:jira-page</source>
- </p>
-
- <p>
- <strong>Note:</strong> The Issue tracking page should only need to be generated initially
- for a component or if the issue tracking template changes.
- </p>
-
- <p>
- This goal uses the following:
- <ul>
- <li>The goal is mapped to the ant script/target using the <code>jira-page</code> mojo defintion in the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>
- ant script</li>
- <li>Uses the <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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>
- </ul>
- </p>
- </subsection>
-
- <subsection name="Configuration">
- <p>
- To generate a JIRA page, the following <i>properties</i> are configured in the component's <code>pom.xml</code>
- <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>
- </ul>
- </p>
- <p>
- Example configuration for Commons Chain:
-<source><![CDATA[
- <properties>
- <commons.jira.id>CHAIN</commons.jira.id>
- <commons.jira.pid>12310462</commons.jira.pid>
- </properties>
-]]></source>
- </p>
- </subsection>
-
- </section>
-
-
<section name="commons:download-page" href="download-page">
<subsection name="Overview">
@@ -137,10 +62,11 @@
<subsection name="Configuration">
<p>
- To generate a Download page, the following <i>properties</i> 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>
<ul>
<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.desc</b> - (<i>optional</i>) The download links are shown in a section with the component name and release version - if this paratmeter 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>
</ul>
@@ -150,59 +76,36 @@
<source><![CDATA[
<properties>
<commons.componentid>chain</commons.componentid>
- <commons.release.version>1.1</commons.release.version>
- <commons.binary.suffix></commons.binary.suffix>
+ <commons.release.version>1.2</commons.release.version>
</properties>
]]></source>
</p>
- </subsection>
-
- </section>
-
-
- <section name="commons:sandbox-jira-page" href="jira-page">
-
- <subsection name="Overview">
- <p>
- The <code>commons:sandbox-jira-page</code> goal generates a custom JIRA Issue Tracking page for a <b>Sandbox</b> component.
- Execute the goal using the following command: <source>mvn commons:sandbox-jira-page</source>
- </p>
-
- <p>
- <strong>Note:</strong> The Issue tracking page should only need to be generated initially
- for a component or if the issue tracking template changes.
- </p>
-
- <p>
- This goal uses the following:
- <ul>
- <li>The goal is mapped to the ant script/target using the <code>sandbox-jira-page</code> mojo defintion in the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>
- ant script</li>
- <li>Uses the <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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>
- </ul>
- </p>
- </subsection>
- <subsection name="Configuration">
<p>
- To generate a JIRA page, the following <i>properties</i> are configured in the component's <code>pom.xml</code>
+ Sometimes there is a requirement to list two versions on the download page. This can be achieved using the following properties:
<ul>
- <li><b>commons.jira.componentid</b> - JIRA's internal (numeric) id for the component</li>
+ <li><b>commons.release.version.2</b> - The version number of the alternative release of the component</li>
+ <li><b>commons.release.desc.2</b> - (<i>optional</i>) Additional text to append to the section name of the alternative release</li>
</ul>
</p>
<p>
- Example configuration:
+ Example configuration for Commons DBCP with two releases:
<source><![CDATA[
<properties>
- <commons.jira.componentid>12311182</commons.jira.componentid>
+ <commons.componentid>dbcp</commons.componentid>
+ <commons.release.version>1.4</commons.release.version>
+ <commons.release.desc>for JDBC 4 (JDK 1.6)</commons.release.desc>
+ <commons.release.version.2>1.3</commons.release.version.2>
+ <commons.release.desc.2> for JDBC 3 (JDK 1.4-1.5)</commons.release.desc.2>
</properties>
]]></source>
</p>
+ <p>
+ The above configuration generates a download page for two releases shown below:
+ </p>
+ <p>
+ <img src="download-page-2release.jpg" alt="Download Page with two release versions"/>
+ </p>
</subsection>
</section>
Modified: commons/proper/commons-build-plugin/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/index.xml?rev=888341&r1=888340&r2=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/index.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/index.xml Tue Dec 8 11:31:00 2009
@@ -44,9 +44,9 @@
<p>
Available Goals:
<ul>
- <li><a href="generate-xdocs-build.html#commons:jira-page">commons:jira-page</a> - Generate a custom JIRA Issue Tracking page for a component</li>
- <li><a href="generate-xdocs-build.html#commons:download-page">commons:download-page</a> - Generate a Download page for the component's latest release</li>
- <li><a href="generate-xdocs-build.html#commons:sandbox-jira-page">commons:sandbox-jira-page</a> - Generate a custom JIRA Issue Tracking page for a Sandbox component</li>
+ <li><a href="download-page.html">commons:download-page</a> - Generate a Download page for the component's latest release</li>
+ <li><a href="jira-page.html">commons:jira-page</a> - Generate a custom JIRA Issue Tracking page for a component</li>
+ <li><a href="sandbox-jira-page.html">commons:sandbox-jira-page</a> - Generate a custom JIRA Issue Tracking page for a Sandbox component</li>
<li><a href="copy-javadoc-files-build.html">commons:copy-javadoc-files</a> - Copy NOTICE and LICENSE files to -javadoc jar</li>
</ul>
</p>
Modified: commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page-mojo.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page-mojo.xml?rev=888341&r1=888340&r2=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page-mojo.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page-mojo.xml Tue Dec 8 11:31:00 2009
@@ -21,83 +21,92 @@
-->
<document>
<properties>
- <title>commons-build-plugin - commons:jira-page</title>
- </properties>
+ <title>commons:jira-page</title>
+ </properties>
<body>
<section name="commons:jira-page">
- <p>Commons Build Ant Mojo: Generate Issue Tracking page</p>
- <p><b>Mojo Attributes</b>:<ul>
- <li>Requires a Maven 2.0 project to execute.</li>
- <li>Is NOT inherited by default in multi-project builds.</li>
- </ul>
- </p>
+ <p><strong>Full name</strong>:</p>
+ <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:jira-page</p>
+ <p><strong>Description</strong>:</p>
+ <div>Commons Build Ant Mojo: Generate Issue Tracking page</div>
+ <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">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#commons.jira.id">commons.jira.id</a></b></td>
+ <td><strong><a href="#commons.jira.id">commons.jira.id</a></strong></td>
<td><code>String</code></td>
- <td>The external JIRA id for the project (alphabetic, upper case) Default value is <code>${commons.jira.id}</code>.</td>
- </tr>
+ <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>
+ </tr>
<tr>
- <td><b><a href="#commons.jira.pid">commons.jira.pid</a></b></td>
+ <td><strong><a href="#commons.jira.pid">commons.jira.pid</a></strong></td>
<td><code>String</code></td>
- <td>The internal JIRA id for the project (numeric) Default value is <code>${commons.jira.pid}</code>.</td>
- </tr>
+ <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>
+ </tr>
<tr>
- <td><b><a href="#basedir">basedir</a></b></td>
+ <td><strong><a href="#basedir">basedir</a></strong></td>
<td><code>File</code></td>
- <td>The base directory from which to execute the Ant script. Default value is <code>${basedir}</code>.</td>
- </tr>
- </table>
- </subsection>
+ <td><code>-</code></td>
+ <td>The base directory from which to execute the Ant script.<br/><strong>Default value is</strong>: <code>${basedir}</code>.</td>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Optional Parameters">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#messageLevel">messageLevel</a></b></td>
+ <td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
- <td>The message-level used to tune the verbosity of Ant logging. Default value is <code>info</code>.</td>
- </tr>
- </table>
- </subsection>
+ <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>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Parameter Details">
- <p><b><a name="commons.jira.id">commons.jira.id</a></b></p>
- <p>The external JIRA id for the project (alphabetic, upper case)</p>
+ <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>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Default</b>: <code>${commons.jira.id}</code></li>
- </ul><hr/><p><b><a name="commons.jira.pid">commons.jira.pid</a></b></p>
- <p>The internal JIRA id for the project (numeric)</p>
+ <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>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Default</b>: <code>${commons.jira.pid}</code></li>
- </ul><hr/><p><b><a name="basedir">basedir</a></b></p>
- <p>The base directory from which to execute the Ant script.</p>
+ <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>
+ <div>The base directory from which to execute the Ant script.</div>
<ul>
- <li><b>Type</b>: <code>java.io.File</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Expression</b>: <code>${antBasedir}</code></li>
- <li><b>Default</b>: <code>${basedir}</code></li>
- </ul><hr/><p><b><a name="messageLevel">messageLevel</a></b></p>
- <p>The message-level used to tune the verbosity of Ant logging.</p>
+ <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>
+ <div>The message-level used to tune the verbosity of Ant logging.</div>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>No</code></li>
- <li><b>Expression</b>: <code>${antMessageLevel}</code></li>
- <li><b>Default</b>: <code>info</code></li>
- </ul>
- </subsection>
- </section>
- </body>
- </document>
\ No newline at end of file
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>No</code></li>
+ <li><strong>Expression</strong>: <code>${antMessageLevel}</code></li>
+ <li><strong>Default</strong>: <code>info</code></li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Copied: commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page.xml (from r887867, commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml)
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page.xml?p2=commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page.xml&p1=commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml&r1=887867&r2=888341&rev=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/jira-page.xml Tue Dec 8 11:31:00 2009
@@ -17,48 +17,24 @@
-->
<!--
$HeadURL$
- $Revision$ $Date$
+ $Revision$
-->
<document>
<properties>
- <title>Generating XDOC files</title>
+ <title>Generating JIRA Page</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
- <section name="Generating XDOC files">
- <p>
- The <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">
- generate-xdocs.build.xml</a> Ant build script contains targets for the following goals:
- <ul>
- <li><a href="#commons:jira-page">commons:jira-page</a> - Generate a JIRA Issue Tracking page for a component</li>
- <li><a href="#commons:download-page">commons:download-page</a> - Generate a Download page for a component's latest release</li>
- <li><a href="#commons:sandbox-jira-page">commons:sandbox-jira-page</a> - Generate a JIRA Issue Tracking page for a Sandbox component</li>
- </ul>
- </p>
-
- <p>
- This script generates custom xdoc pages for Commons components using
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/">templates</a>
- and <a href="http://ant.apache.org/manual/CoreTasks/filter.html">Ant's filtering</a> functionality:
- </p>
-
- <p>
- These goals (re-)generate xdoc files in either the default m1 location (i.e. <code>xdocs</code>) or the default m2 location
- (i.e. <code>src/site/xdoc</code>). Once generated these can be checked into svn and the component's site regenerated using <code>mvn site</code>.
- </p>
-
- </section>
-
-
<section name="commons:jira-page" href="jira-page">
<subsection name="Overview">
<p>
- The <code>commons:jira-page</code> goal generates a custom JIRA Issue Tracking page for a component.
+ The <code>commons: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:sandbox-jira-page</a> goal).
Execute the goal using the following command: <source>mvn commons:jira-page</source>
</p>
@@ -84,7 +60,7 @@
<subsection name="Configuration">
<p>
- To generate a JIRA page, the following <i>properties</i> 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>
<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>
@@ -103,109 +79,5 @@
</section>
-
- <section name="commons:download-page" href="download-page">
-
- <subsection name="Overview">
- <p>
- The <code>commons:download-page</code> goal generates a custom Download page for the latest release of a component.
- Execute the goal using the following command: <source>mvn commons:download-page</source>
- </p>
-
- <p>
- <strong>Note:</strong> The Download page should only need to be re-generated after a new release of the component
- or if the download page template changes.
- </p>
-
- <p>
- This goal uses the following:
- <ul>
- <li>The goal is mapped to the ant script/target using the <code>download-page</code> mojo defintion in the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>
- ant script</li>
- <li>Uses either the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/download-page-template.xml">download-page-template.xml</a> or
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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>
- </ul>
- </p>
- </subsection>
-
- <subsection name="Configuration">
- <p>
- To generate a Download page, the following <i>properties</i> are configured in the component's <code>pom.xml</code>
- <ul>
- <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.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>
- </ul>
- </p>
- <p>
- Example configuration for Commons Chain:
-<source><![CDATA[
- <properties>
- <commons.componentid>chain</commons.componentid>
- <commons.release.version>1.1</commons.release.version>
- <commons.binary.suffix></commons.binary.suffix>
- </properties>
-]]></source>
- </p>
- </subsection>
-
- </section>
-
-
- <section name="commons:sandbox-jira-page" href="jira-page">
-
- <subsection name="Overview">
- <p>
- The <code>commons:sandbox-jira-page</code> goal generates a custom JIRA Issue Tracking page for a <b>Sandbox</b> component.
- Execute the goal using the following command: <source>mvn commons:sandbox-jira-page</source>
- </p>
-
- <p>
- <strong>Note:</strong> The Issue tracking page should only need to be generated initially
- for a component or if the issue tracking template changes.
- </p>
-
- <p>
- This goal uses the following:
- <ul>
- <li>The goal is mapped to the ant script/target using the <code>sandbox-jira-page</code> mojo defintion in the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>
- ant script</li>
- <li>Uses the <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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>
- </ul>
- </p>
- </subsection>
-
- <subsection name="Configuration">
- <p>
- To generate a JIRA page, the following <i>properties</i> are configured in the component's <code>pom.xml</code>
- <ul>
- <li><b>commons.jira.componentid</b> - JIRA's internal (numeric) id for the component</li>
- </ul>
- </p>
- <p>
- Example configuration:
-<source><![CDATA[
- <properties>
- <commons.jira.componentid>12311182</commons.jira.componentid>
- </properties>
-]]></source>
- </p>
- </subsection>
-
- </section>
-
</body>
</document>
Modified: commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page-mojo.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page-mojo.xml?rev=888341&r1=888340&r2=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page-mojo.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page-mojo.xml Tue Dec 8 11:31:00 2009
@@ -21,72 +21,80 @@
-->
<document>
<properties>
- <title>commons-build-plugin - commons:sandbox-jira-page</title>
- </properties>
+ <title>commons:sandbox-jira-page</title>
+ </properties>
<body>
<section name="commons:sandbox-jira-page">
- <p>Commons Build Ant Mojo: Generate Sandbox Issue Tracking page</p>
- <p><b>Mojo Attributes</b>:<ul>
- <li>Requires a Maven 2.0 project to execute.</li>
- <li>Is NOT inherited by default in multi-project builds.</li>
- </ul>
- </p>
+ <p><strong>Full name</strong>:</p>
+ <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:sandbox-jira-page</p>
+ <p><strong>Description</strong>:</p>
+ <div>Commons Build Ant Mojo: Generate Sandbox Issue Tracking page</div>
+ <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">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#commons.jira.componentid">commons.jira.componentid</a></b></td>
+ <td><strong><a href="#commons.jira.componentid">commons.jira.componentid</a></strong></td>
<td><code>String</code></td>
- <td>The internal JIRA component id (numeric) Default value is <code>${commons.jira.componentid}</code>.</td>
- </tr>
+ <td><code>-</code></td>
+ <td>The internal JIRA component id (numeric)<br/><strong>Default value is</strong>: <code>${commons.jira.componentid}</code>.</td>
+ </tr>
<tr>
- <td><b><a href="#basedir">basedir</a></b></td>
+ <td><strong><a href="#basedir">basedir</a></strong></td>
<td><code>File</code></td>
- <td>The base directory from which to execute the Ant script. Default value is <code>${basedir}</code>.</td>
- </tr>
- </table>
- </subsection>
+ <td><code>-</code></td>
+ <td>The base directory from which to execute the Ant script.<br/><strong>Default value is</strong>: <code>${basedir}</code>.</td>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Optional Parameters">
- <table>
+ <table border="0" align="left">
<tr>
<th>Name</th>
<th>Type</th>
+ <th>Since</th>
<th>Description</th>
- </tr>
+ </tr>
<tr>
- <td><b><a href="#messageLevel">messageLevel</a></b></td>
+ <td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
- <td>The message-level used to tune the verbosity of Ant logging. Default value is <code>info</code>.</td>
- </tr>
- </table>
- </subsection>
+ <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>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Parameter Details">
- <p><b><a name="commons.jira.componentid">commons.jira.componentid</a></b></p>
- <p>The internal JIRA component id (numeric)</p>
+ <p><strong><a name="commons.jira.componentid">commons.jira.componentid</a>:</strong></p>
+ <div>The internal JIRA component id (numeric)</div>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Default</b>: <code>${commons.jira.componentid}</code></li>
- </ul><hr/><p><b><a name="basedir">basedir</a></b></p>
- <p>The base directory from which to execute the Ant script.</p>
+ <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>
+ <div>The base directory from which to execute the Ant script.</div>
<ul>
- <li><b>Type</b>: <code>java.io.File</code></li>
- <li><b>Required</b>: <code>Yes</code></li>
- <li><b>Expression</b>: <code>${antBasedir}</code></li>
- <li><b>Default</b>: <code>${basedir}</code></li>
- </ul><hr/><p><b><a name="messageLevel">messageLevel</a></b></p>
- <p>The message-level used to tune the verbosity of Ant logging.</p>
+ <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>
+ <div>The message-level used to tune the verbosity of Ant logging.</div>
<ul>
- <li><b>Type</b>: <code>java.lang.String</code></li>
- <li><b>Required</b>: <code>No</code></li>
- <li><b>Expression</b>: <code>${antMessageLevel}</code></li>
- <li><b>Default</b>: <code>info</code></li>
- </ul>
- </subsection>
- </section>
- </body>
- </document>
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>No</code></li>
+ <li><strong>Expression</strong>: <code>${antMessageLevel}</code></li>
+ <li><strong>Default</strong>: <code>info</code></li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Copied: commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page.xml (from r887867, commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml)
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page.xml?p2=commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page.xml&p1=commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml&r1=887867&r2=888341&rev=888341&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/generate-xdocs-build.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/sandbox-jira-page.xml Tue Dec 8 11:31:00 2009
@@ -22,149 +22,19 @@
<document>
<properties>
- <title>Generating XDOC files</title>
+ <title>Generating Sandbox JIRA Page</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
- <section name="Generating XDOC files">
- <p>
- The <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">
- generate-xdocs.build.xml</a> Ant build script contains targets for the following goals:
- <ul>
- <li><a href="#commons:jira-page">commons:jira-page</a> - Generate a JIRA Issue Tracking page for a component</li>
- <li><a href="#commons:download-page">commons:download-page</a> - Generate a Download page for a component's latest release</li>
- <li><a href="#commons:sandbox-jira-page">commons:sandbox-jira-page</a> - Generate a JIRA Issue Tracking page for a Sandbox component</li>
- </ul>
- </p>
-
- <p>
- This script generates custom xdoc pages for Commons components using
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/">templates</a>
- and <a href="http://ant.apache.org/manual/CoreTasks/filter.html">Ant's filtering</a> functionality:
- </p>
-
- <p>
- These goals (re-)generate xdoc files in either the default m1 location (i.e. <code>xdocs</code>) or the default m2 location
- (i.e. <code>src/site/xdoc</code>). Once generated these can be checked into svn and the component's site regenerated using <code>mvn site</code>.
- </p>
-
- </section>
-
-
- <section name="commons:jira-page" href="jira-page">
-
- <subsection name="Overview">
- <p>
- The <code>commons:jira-page</code> goal generates a custom JIRA Issue Tracking page for a component.
- Execute the goal using the following command: <source>mvn commons:jira-page</source>
- </p>
-
- <p>
- <strong>Note:</strong> The Issue tracking page should only need to be generated initially
- for a component or if the issue tracking template changes.
- </p>
-
- <p>
- This goal uses the following:
- <ul>
- <li>The goal is mapped to the ant script/target using the <code>jira-page</code> mojo defintion in the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>
- ant script</li>
- <li>Uses the <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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>
- </ul>
- </p>
- </subsection>
-
- <subsection name="Configuration">
- <p>
- To generate a JIRA page, the following <i>properties</i> are configured in the component's <code>pom.xml</code>
- <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>
- </ul>
- </p>
- <p>
- Example configuration for Commons Chain:
-<source><![CDATA[
- <properties>
- <commons.jira.id>CHAIN</commons.jira.id>
- <commons.jira.pid>12310462</commons.jira.pid>
- </properties>
-]]></source>
- </p>
- </subsection>
-
- </section>
-
-
- <section name="commons:download-page" href="download-page">
-
- <subsection name="Overview">
- <p>
- The <code>commons:download-page</code> goal generates a custom Download page for the latest release of a component.
- Execute the goal using the following command: <source>mvn commons:download-page</source>
- </p>
-
- <p>
- <strong>Note:</strong> The Download page should only need to be re-generated after a new release of the component
- or if the download page template changes.
- </p>
-
- <p>
- This goal uses the following:
- <ul>
- <li>The goal is mapped to the ant script/target using the <code>download-page</code> mojo defintion in the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>
- ant script</li>
- <li>Uses either the
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/download-page-template.xml">download-page-template.xml</a> or
- <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/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>
- </ul>
- </p>
- </subsection>
-
- <subsection name="Configuration">
- <p>
- To generate a Download page, the following <i>properties</i> are configured in the component's <code>pom.xml</code>
- <ul>
- <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.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>
- </ul>
- </p>
- <p>
- Example configuration for Commons Chain:
-<source><![CDATA[
- <properties>
- <commons.componentid>chain</commons.componentid>
- <commons.release.version>1.1</commons.release.version>
- <commons.binary.suffix></commons.binary.suffix>
- </properties>
-]]></source>
- </p>
- </subsection>
-
- </section>
-
-
<section name="commons:sandbox-jira-page" href="jira-page">
<subsection name="Overview">
<p>
- The <code>commons:sandbox-jira-page</code> goal generates a custom JIRA Issue Tracking page for a <b>Sandbox</b> component.
+ The <code>commons: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:jira-page</a> goal).
Execute the goal using the following command: <source>mvn commons:sandbox-jira-page</source>
</p>
@@ -190,7 +60,7 @@
<subsection name="Configuration">
<p>
- To generate a JIRA page, the following <i>properties</i> 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>
<ul>
<li><b>commons.jira.componentid</b> - JIRA's internal (numeric) id for the component</li>
</ul>