Add docs for changes:transform tag library

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@434554 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl 2006-08-24 22:52:29 +00:00
parent 8e61bd2d66
commit 7757b3af9c
2 changed files with 69 additions and 0 deletions

View File

@ -31,6 +31,7 @@
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
<item name="Tags" href="/tags.html"/>
</menu>
</body>
</project>

68
changes/xdocs/tags.xml Normal file
View File

@ -0,0 +1,68 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2006 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<title>Plugin tags</title>
</properties>
<body>
<section name="Overview">
<p>The following tag libraries and tags are provided by this plugin.</p>
<ol>
<li><a href="#changes:transform_Tag_Library">changes:transform</a>
<ol>
<li><a href="#release-version_Tag">release-version</a></li>
</ol>
</li>
</ol>
</section>
<section name="changes:transform Tag Library">
<subsection name="release-version Tag">
<p>
Updates the changes.xml file in preparation for a release.
Used by the <code>scm:prepare-release</code> goal.
</p>
<table>
<tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>version</td>
<td>No</td>
<td>The version attribute of the release tag in changes.xml.</td>
</tr>
<tr>
<td>encoding</td>
<td>Yes</td>
<td>
The encoding of changes.xml file.
If not given, the property maven.changes.outputencoding will be used.
</td>
</tr>
<tr>
<td>date</td>
<td>Yes</td>
<td>
The date attribute of the release tag in changes.xml.
If not given, the current date will be used.
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>