Author: niallp
Date: Wed Apr 7 13:32:33 2010
New Revision: 931536
URL: http://svn.apache.org/viewvc?rev=931536&view=rev
Log:
Add facility to generate custom Mailing List page
Added:
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
(with props)
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
(with props)
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
(with props)
Modified:
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
commons/proper/commons-build-plugin/trunk/src/site/site.xml
Added:
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml?rev=931536&view=auto
==============================================================================
---
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
(added)
+++
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
Wed Apr 7 13:32:33 2010
@@ -0,0 +1,138 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: mail-lists-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:mail-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>@NAME@ Mailing Lists</title>
+ <author email="[email protected]">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="@NAME@ Mailing Lists">
+ <p>
+ Apache Commons shares mailing lists for all of its
+ <a href="http://commons.apache.org/components.html";>components</a>.
+ To make it easier for people to only read messages related to
components thet are interested in,
+ the convention in Commons is to prefix the subject line of messages
with the component name.
+ </p>
+ <p>
+ <strong>Please prefix the subject line of any messages for @NAME@ with
[...@id@]</strong> - <i>thanks!</i>
+ </p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Subscribe</th>
+ <th>Unsubscribe</th>
+ <th>Post</th>
+ <th>Archive</th>
+ <th>Other Archives</th>
+ </tr>
+
+
+ <tr>
+ <td><strong>User List</strong></td>
+ <td><a
href="mailto:[email protected]";>Subscribe</a></td>
+ <td><a
href="mailto:[email protected]";>Unsubscribe</a></td>
+ <td><a href="mailto:[email protected]";>Post</a></td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-user/";>mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.users/";>markmail.org</a></td>
+ </tr>
+ <tr>
+ <td>-</td><td>-</td><td>-</td><td>-</td><td>-</td>
+ <td><a
href="http://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a></td>
+ </tr>
+ <tr>
+ <td>-</td><td>-</td><td>-</td><td>-</td><td>-</td>
+ <td><a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a></td>
+ </tr>
+
+
+ <tr>
+ <td><strong>Dev List</strong></td>
+ <td><a
href="mailto:[email protected]";>Subscribe</a></td>
+ <td><a
href="mailto:[email protected]";>Unsubscribe</a></td>
+ <td><a href="mailto:[email protected]";>Post</a></td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/";>mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.dev/";>markmail.org</a></td>
+ </tr>
+ <tr>
+ <td>-</td><td>-</td><td>-</td><td>-</td><td>-</td>
+ <td><a
href="http://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a></td>
+ </tr>
+ <tr>
+ <td>-</td><td>-</td><td>-</td><td>-</td><td>-</td>
+ <td><a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a></td>
+ </tr>
+
+
+ <tr>
+ <td><strong>Issues List</strong></td>
+ <td><a
href="mailto:[email protected]";>Subscribe</a></td>
+ <td><a
href="mailto:[email protected]";>Unsubscribe</a></td>
+ <td>-</td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-issues/";>mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.issues/";>markmail.org</a></td>
+ </tr>
+ <tr>
+ <td>-</td><td>-</td><td>-</td><td>-</td><td>-</td>
+ <td><a
href="http://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a></td>
+ </tr>
+
+
+ <tr>
+ <td><strong>Commits List</strong></td>
+ <td><a
href="mailto:[email protected]";>Subscribe</a></td>
+ <td><a
href="mailto:[email protected]";>Unsubscribe</a></td>
+ <td>-</td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-commits/";>mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.commits/";>markmail.org</a></td>
+ </tr>
+ <tr>
+ <td>-</td><td>-</td><td>-</td><td>-</td><td>-</td>
+ <td><a
href="http://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a></td>
+ </tr>
+
+
+ </table>
+ </section>
+ </body>
+</document>
Propchange:
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Modified:
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml?rev=931536&r1=931535&r2=931536&view=diff
==============================================================================
---
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
(original)
+++
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
Wed Apr 7 13:32:33 2010
@@ -27,6 +27,42 @@
<property name="commonsMojoTempDir" value="target/commons-generated-xdocs"
/>
<property name="level" value="info" />
+ <!-- ========== Generate Mailing List Page
================================ -->
+
+ <target name="mail-page" description="Generate Mailing List page">
+
+ <echo level="${level}" message="----- commons:mailing-list -
Parameters - START -----" />
+ <echo level="${level}" message="project.name :
${project.name}" />
+ <echo level="${level}" message="commons.componentid :
${commons.componentid}" />
+ <echo level="${level}" message="commons.xdoc.dir :
${commons.xdoc.dir}" />
+ <echo level="${level}" message="----- commons:mailing-list -
Parameters - END -----" />
+
+ <echo level="info" message="*** Generating ${project.name} Mailing
List Page ***" />
+
+ <!-- Create a temporary directory to load the template files into -->
+ <mkdir dir="${commonsMojoTempDir}"/>
+
+ <!-- Load the issue-tracking template from mojo resources to temp
directory -->
+ <loadresource property="mailinglists-xml">
+ <javaresource
name="${commonsMojoXdocDir}/mail-lists-template.xml"/>
+ </loadresource>
+ <echo message="${mailinglists-xml}"
file="${commonsMojoTempDir}/mail-lists-template.xml" append="false" />
+
+ <!-- Copy the mail-lists template filtering to replace properties -->
+ <copy file="${commonsMojoTempDir}/mail-lists-template.xml"
tofile="${commonsMojoTempDir}/mail-lists.xml" overwrite="true">
+ <filterset>
+ <filter token="NAME" value="${project.name}"/>
+ <filter token="ID" value="${commons.componentid}"/>
+ </filterset>
+ </copy>
+
+ <!-- copy to either m1 or m2 xdoc directory -->
+ <antcall target="copy-to-xdoc-dir">
+ <param name="file.name" value="mail-lists.xml"/>
+ </antcall>
+
+ </target>
+
<!-- ========== Generate Issue Tracking Page
============================== -->
<target name="jira-page" description="Generate JIRA Issue Tracking page">
Modified:
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml?rev=931536&r1=931535&r2=931536&view=diff
==============================================================================
---
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
(original)
+++
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
Wed Apr 7 13:32:33 2010
@@ -25,6 +25,32 @@
<pluginMetadata>
<mojos>
<mojo>
+ <goal>mail-page</goal>
+ <call>mail-page</call>
+ <description>Commons Build Ant Mojo: Generate Mailing List
page</description>
+ <requiresProject>true</requiresProject>
+ <parameters>
+ <parameter>
+ <name>project.name</name>
+ <property>project.name</property>
+ <required>true</required>
+ <readonly>true</readonly>
+ <defaultValue>${project.name}</defaultValue>
+ <type>java.lang.String</type>
+ <description>The name of the project currently being
built.</description>
+ </parameter>
+ <parameter>
+ <name>commons.componentid</name>
+ <property>commons.componentid</property>
+ <required>true</required>
+ <readonly>true</readonly>
+ <defaultValue>${commons.componentid}</defaultValue>
+ <type>java.lang.String</type>
+ <description>The commons component id.</description>
+ </parameter>
+ </parameters>
+ </mojo>
+ <mojo>
<goal>jira-page</goal>
<call>jira-page</call>
<description>Commons Build Ant Mojo: Generate Issue Tracking
page</description>
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=931536&r1=931535&r2=931536&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/site.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/site.xml Wed Apr 7
13:32:33 2010
@@ -38,6 +38,10 @@
<item name="properties"
href="/sandbox-jira-page-mojo.html"/>
</item>
</item>
+ <item name="Mail Page" href="/mail-page.html">
+ <item name="mail-page" href="/mail-page.html"/>
+ <item name="properties" href="/mail-page-mojo.html"/>
+ </item>
<item name="Help" href="/development.html">
<item name="Issue Tracking" href="/issue-tracking.html"/>
<item name="Development" href="/development.html"/>
Added:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml?rev=931536&view=auto
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
(added)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
Wed Apr 7 13:32:33 2010
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!--
+ $HeadURL$
+ $Revision$
+ -->
+<document>
+ <properties>
+ <title>commons:mail-page</title>
+ </properties>
+ <body>
+ <section name="commons:mail-page">
+ <p><strong>Full name</strong>:</p>
+ <p>org.apache.commons:commons-build-plugin:1.3-SNAPSHOT:mail-page</p>
+ <p><strong>Description</strong>:</p>
+ <div>Commons Build Ant Mojo: Generate Mailing List 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 border="0" align="left">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Since</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><strong><a href="#basedir">basedir</a></strong></td>
+ <td><code>File</code></td>
+ <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 border="0" align="left">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Since</th>
+ <th>Description</th>
+ </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><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><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
Propchange:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml?rev=931536&view=auto
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
(added)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml Wed
Apr 7 13:32:33 2010
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!--
+ $HeadURL$
+ $Revision$
+ -->
+<document>
+
+ <properties>
+ <title>Generating Mailing List Page</title>
+ <author email="[email protected]">Commons Documentation
Team</author>
+ </properties>
+
+ <body>
+
+
+ <section name="commons:mail-page" href="mail-page">
+
+ <subsection name="Overview">
+ <p>
+ The <code>commons:mail-page</code> goal generates a custom
Mailing List page for a component
+ Execute the goal using the following command: <source>mvn
commons:mail-page</source>
+ </p>
+
+ <p>
+ <strong>Note:</strong> The Mailing List page should only need
to be generated initially
+ for a component or if the Mailing List template changes.
+ </p>
+
+ <p>
+ This goal uses the following:
+ <ul>
+ <li>The goal is mapped to the ant script/target using the
<code>mail-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>mail-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/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>
+ </ul>
+ </p>
+ </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>
+ <ul>
+ <li><b>commons.componentid</b> - Commons component id</li>
+ </ul>
+ </p>
+ <p>
+ Example configuration for Commons Chain:
+<source><![CDATA[
+ <properties>
+ <commons.componentid>chain</commons.componentid>
+ </properties>
+]]></source>
+ </p>
+ </subsection>
+
+ </section>
+
+ </body>
+</document>
Propchange:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
