dion 2002/10/12 08:42:46
Modified: src/plugins-build/changelog/xdocs properties.xml index.xml
src/plugins-build/changelog plugin.jelly
Added: src/plugins-build/changelog/xdocs changes.xml goals.xml
navigation.xml
Log:
Fixed docs
Revision Changes Path
1.5 +39 -0
jakarta-turbine-maven/src/plugins-build/changelog/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/changelog/xdocs/properties.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- properties.xml 14 Sep 2002 05:07:22 -0000 1.4
+++ properties.xml 12 Oct 2002 15:42:45 -0000 1.5
@@ -10,6 +10,11 @@
<section name="Changelog Properties">
<table>
<tr>
+ <th>Property name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
<td>maven.changelog.range</td>
<td>Yes</td>
<td>
@@ -41,6 +46,40 @@
a StarTeam factory (<a
href="../apidocs/org/apache/maven/starteamlib/StarteamChangeLogFactory.html">
org.apache.maven.starteamlib.StarteamChangeLogFactory</a>).
+ </td>
+ </tr>
+ <tr>
+ <td>maven.docs.outputencoding</td>
+ <td>Yes</td>
+ <td>
+ The output encoding for the generated xml documents. Set by
+ the xdoc plugin, it defaults to <code>ISO-8859-1</code>
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="Other properties">
+ <table>
+ <tr>
+ <th>Property name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.gen.docs</td>
+ <td>Yes</td>
+ <td>
+ The directory where the generated report is created.
+ This directory holds the generated documents for
+ processing by the xdoc plugin.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.mode.online</td>
+ <td>Yes</td>
+ <td>
+ Used by the plugin to check if the user is currently 'online'
+ and hence has access to the source code repository.
</td>
</tr>
</table>
1.3 +12 -2
jakarta-turbine-maven/src/plugins-build/changelog/xdocs/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/changelog/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 10 Sep 2002 01:28:52 -0000 1.2
+++ index.xml 12 Oct 2002 15:42:45 -0000 1.3
@@ -4,6 +4,7 @@
<properties>
<title>Maven Changelog Plug-in</title>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
+ <author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
@@ -11,8 +12,17 @@
<p>
This plugin produces a nicely formatted changelog report so project
team members can see at a glance what changes have been made
- recently to the project. Currently, there are two supported
- source control systems: CVS and Subversion.
+ recently to the project. Currently, there are three supported
+ source control systems: CVS, StarTeam and Subversion.
+ </p>
+ <p>
+ For more information on the functionality provided by this plugin,
+ please see the <a href="goals.html">Goals</a> document.
+ </p>
+ <p>
+ For more information on how to customise the functionality provided
+ by this plugin, please see the <a href="properties.html">properties</a>
+ document.
</p>
</section>
</body>
1.1
jakarta-turbine-maven/src/plugins-build/changelog/xdocs/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Changes</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<release version="1.2" date="in CVS">
<action dev="dion" type="add">
<p>
Added more documentation
</p>
</action>
<action dev="dion" type="add">
Reworked CVS changelog plugin to use the project repository
connection string, rather than relying on CVS/Entries
</action>
</release>
<release version="1.1" date="2002-08-01">
<action dev="smor" type="fix">
Fix for Maven-5
</action>
</release>
</body>
</document>
1.1
jakarta-turbine-maven/src/plugins-build/changelog/xdocs/goals.xml
Index: goals.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven Ant Plug-in Goals</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>changelog</td>
<td>
This is the default goal of the plugin and simply attains
the <code>changelog:generate</code> goal.
</td>
</tr>
<tr>
<td>changelog:generate</td>
<td>
Generates a report from the source control system showing
changes by date along with the message, if any, provided
by the developer when making the change
</td>
</tr>
</table>
</section>
</body>
</document>
1.1
jakarta-turbine-maven/src/plugins-build/changelog/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven Change log Plugin">
<title>Maven Change log Plugin</title>
<body>
<links>
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
<item name="CVS" href="http://www.cvshome.org/"/>
<item name="StarTeam" href="http://www.starbase.com/product_starteam/"/>
<item name="Subversion" href="http://subversion.tigris.org/"; />
</links>
<menu name="Overview">
<item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
</menu>
</body>
</project>
1.11 +1 -1 jakarta-turbine-maven/src/plugins-build/changelog/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/changelog/plugin.jelly,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- plugin.jelly 12 Oct 2002 05:59:37 -0000 1.10
+++ plugin.jelly 12 Oct 2002 15:42:46 -0000 1.11
@@ -26,7 +26,7 @@
/>
</define:taglib>
- <mkdir dir="${maven.build.dir}/generated-xdocs"/>
+ <mkdir dir="${maven.gen.docs}"/>
<changelog:changelog
basedir="${basedir}"
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
