maven-plugins/changes/xdocs/properties.xml
2003-02-24 13:05:07 +00:00

89 lines
3.1 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Changelog Properties</title>
<author email="smor@apache.org">Stéphane MOR</author>
</properties>
<body>
<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>
Specifies the range to use when generating the change log.
This is used by the "changelog" goal. The default value is
<code>5</code> days. Note: when using the Subversion
changelog factory, you <b>must</b> set this property to an
empty value because the Subversion ra_dav module (used to
access DAV repositories) does not support date operations
yet. If you are using a local repository (ra_local), then
this does not apply to you.
</td>
</tr>
<tr>
<td>maven.changelog.factory</td>
<td>Yes</td>
<td>
Specifies a fully qualified class name implementing the
<code>org.apache.maven.changelog.ChangeLogFactory</code> interface.
The class creates the <code>ChangeLogGenerator</code> and
<code>ChangeLogParser</code> pair required to create the change
log. This is used by the "changelog" and "activity" goals.
The default value is <a
href="../apidocs/org/apache/maven/cvslib/CvsChangeLogFactory.html">
org.apache.maven.cvslib.CvsChangeLogFactory</a>. In
addition, there is also a Subversion factory (<a
href="../apidocs/org/apache/maven/svnlib/SvnChangeLogFactory.html">
org.apache.maven.svnlib.SvnChangeLogFactory</a>) as well as
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>
</section>
</body>
</document>