You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by lt...@apache.org on 2005/09/21 02:12:33 UTC
svn commit: r290590 - in /maven/maven-1/plugins/trunk/xdoc/xdocs:
changes.xml navigation.xml tags.xml
Author: ltheussl
Date: Tue Sep 20 17:12:27 2005
New Revision: 290590
URL: http://svn.apache.org/viewcvs?rev=290590&view=rev
Log:
MPXDOC-169: Add xdoc tag library documentation to the plugin site
Added:
maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml
Modified:
maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml?rev=290590&r1=290589&r2=290590&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml Tue Sep 20 17:12:27 2005
@@ -27,6 +27,7 @@
</properties>
<body>
<release version="1.10" date="in SVN">
+ <action dev="ltheussl" type="add" issue="MPXDOC-169">Add xdoc tag library documentation to the plugin site.</action>
<action dev="ltheussl" type="fix" issue="MPXDOC-87">Fix <code>xdoc:validate</code>.</action>
<action dev="ltheussl" type="fix" issue="MPXDOC-106" due-to="Jerome Lacoste">One cannot call xdoc:copy-user-resources directly.</action>
<action dev="ltheussl" type="add" issue="MPXDOC-126" due-to="Maarten Coene">Add support for more powered-by banners.</action>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml?rev=290590&r1=290589&r2=290590&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml Tue Sep 20 17:12:27 2005
@@ -29,6 +29,7 @@
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
+ <item name="Tags" href="/tags.html"/>
<item name="i18n" href="/i18n.html"/>
<item name="FAQs" href="/faq.html"/>
</menu>
Added: maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml?rev=290590&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml (added)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml Tue Sep 20 17:12:27 2005
@@ -0,0 +1,332 @@
+<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="#doc_Tag_Library">doc</a>
+ <ol>
+ <li><a href="#deregisterReport_Tag">deregisterReport</a></li>
+ <li><a href="#registerReport_Tag">registerReport</a></li>
+ <li><a href="#formatAsNumber_Tag">formatAsNumber</a></li>
+ <li><a href="#jslFile_Tag">jslFile</a></li>
+ <li><a href="#jsl_Tag">jsl</a></li>
+ <li><a href="#itemLink_Tag">itemLink</a></li>
+ <li><a href="#text-xdoc_Tag">text-xdoc</a></li>
+ <li><a href="#printRow_Tag">printRow</a></li>
+ <li><a href="#performJSL_Tag">performJSL</a></li>
+ <li><a href="#performJSLTransform_Tag">performJSLTransform</a></li>
+ <li><a href="#performJSL-i18n_Tag">performJSL-i18n</a></li>
+ <li><a href="#jslToSite_Tag">jslToSite</a></li>
+ <li><a href="#escapeNameToken_Tag">escapeNameToken</a></li>
+ </ol>
+ </li>
+ </ol>
+ </section>
+ <section name="doc Tag Library">
+ <subsection name="deregisterReport Tag">
+ <p>Deregister a report from xdoc.</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>name</td>
+ <td>No</td>
+ <td> Report to deregister, must be same as name used to register.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="registerReport Tag">
+ <p>A tag to register a report with xdoc.</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>name</td>
+ <td>No</td>
+ <td>The name of the report to register.</td>
+ </tr>
+ <tr>
+ <td>pluginName</td>
+ <td>No</td>
+ <td>The name of the plugin. the plugin:report goal must exist</td>
+ </tr>
+ <tr>
+ <td>description</td>
+ <td>Yes</td>
+ <td>A text description of the report.</td>
+ </tr>
+ <tr>
+ <td>link</td>
+ <td>No</td>
+ <td>The nav-bar link for this report.</td>
+ </tr>
+ <tr>
+ <td>target</td>
+ <td>Yes</td>
+ <td>The target for the new page (_self, _blank, ...).</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="formatAsNumber Tag">
+ <p>Calls org.apache.maven.util.DVSLFormatter</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>string</td>
+ <td>No</td>
+ <td>The string to format.</td>
+ </tr>
+ <tr>
+ <td>pattern</td>
+ <td>No</td>
+ <td>The pattern.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="jslFile Tag">
+ <p>
+ Basic tag for performing arbitrary jsl transformations
+ on arbitrary jsl inputs.
+ </p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>input</td>
+ <td>Yes</td>
+ <td>The input file.</td>
+ </tr>
+ <tr>
+ <td>output</td>
+ <td>No</td>
+ <td>The output file.</td>
+ </tr>
+ <tr>
+ <td>stylesheet</td>
+ <td>No</td>
+ <td>The stylesheet to use in the transformation.</td>
+ </tr>
+ <tr>
+ <td>encoding</td>
+ <td>Yes</td>
+ <td>The encoding of the output file.</td>
+ </tr>
+ <tr>
+ <td>omitXmlDeclaration</td>
+ <td>Yes</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>outputMode</td>
+ <td>No</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>prettyPrint</td>
+ <td>Yes</td>
+ <td></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="jsl Tag">
+ <p>
+ This tag has a lot of defaults suitable for transforming
+ documents easily.
+ </p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>input</td>
+ <td>Yes</td>
+ <td>The input file.</td>
+ </tr>
+ <tr>
+ <td>outputDirectory</td>
+ <td>Yes</td>
+ <td>Will be placed under <code>${maven.gen.docs}</code>.</td>
+ </tr>
+ <tr>
+ <td>stylesheet</td>
+ <td>No</td>
+ <td>The stylesheet to use in the transformation.</td>
+ </tr>
+ <tr>
+ <td>encoding</td>
+ <td>Yes</td>
+ <td>Defaults to <code>${maven.docs.outputencoding}</code>.</td>
+ </tr>
+ <tr>
+ <td>omitXmlDeclaration</td>
+ <td>Yes</td>
+ <td>Defaults to <code>${maven.docs.omitXmlDeclaration}</code>.</td>
+ </tr>
+ <tr>
+ <td>outputMode</td>
+ <td>No</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>prettyPrint</td>
+ <td>Yes</td>
+ <td></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="itemLink Tag">
+ <p>Used to generate the links in the navigation bar.</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>link</td>
+ <td>No</td>
+ <td>The link URL.</td>
+ </tr>
+ <tr>
+ <td>relativePath</td>
+ <td>Yes</td>
+ <td>The relative path to the link location.</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>No</td>
+ <td>The name of the link.</td>
+ </tr>
+ <tr>
+ <td>img</td>
+ <td>Yes</td>
+ <td>An optional image to display instead of the link name.</td>
+ </tr>
+ <tr>
+ <td>state</td>
+ <td>Yes</td>
+ <td>expanded | collapsed | none.</td>
+ </tr>
+ <tr>
+ <td>target</td>
+ <td>Yes</td>
+ <td></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="text-xdoc Tag">
+ <p>Wraps a text in a CDATA section.</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>output</td>
+ <td>No</td>
+ <td>The output file.</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>Yes</td>
+ <td>The title for the page.</td>
+ </tr>
+ <tr>
+ <td>section</td>
+ <td>Yes</td>
+ <td>The section heading.</td>
+ </tr>
+ <tr>
+ <td>encoding</td>
+ <td>Yes</td>
+ <td>Defaults to <code>${maven.docs.outputencoding}</code>.</td>
+ </tr>
+ <tr>
+ <td>preamble</td>
+ <td>Yes</td>
+ <td>Placed in paragraph block prior to text.</td>
+ </tr>
+ <tr>
+ <td>inputText</td>
+ <td>No</td>
+ <td>Will be wrapped in a CDATA, will not escape CDATA tags (as yet).</td>
+ </tr>
+ <tr>
+ <td>inputFile</td>
+ <td>Yes</td>
+ <td>Will be read in and wrapped in CDATA. Overrides inputText if set.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="printRow Tag">
+ <p>Alternator for row style in a table.</p>
+ </subsection>
+ <subsection name="performJSL Tag">
+ <p>
+ Generates the JSL files on the given srcdir attribute depending on
+ the locale wanted.
+ </p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>srcdir</td>
+ <td>No</td>
+ <td>
+ Input will be read from <code>${srcdir}/${locale}</code>
+ and put into <code>${destdir}/${locale}</code> for every locale
+ defined (except the default locale).
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="performJSLTransform Tag">
+ <p>Generates the JSL files on the given srcdir attribute.</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>srcdir</td>
+ <td>No</td>
+ <td>The input directory.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="performJSL-i18n Tag">
+ <p>Generates the JSL files on the given srcdir attribute.</p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>srcdir</td>
+ <td>No</td>
+ <td>The input directory.</td>
+ </tr>
+ <tr>
+ <td>destdir</td>
+ <td>No</td>
+ <td>The output directory.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="jslToSite Tag">
+ <p>
+ Transforms files in the given dir using the site stylesheet and
+ navigation and place them in <code>maven.docs.dest</code>
+ (typically <code>target/docs</code>).
+ </p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>srcdir</td>
+ <td>No</td>
+ <td>The input directory.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="escapeNameToken Tag">
+ <p>
+ Escapes a string for generating a valid name token
+ (needed for "name" attribute in html anchors).
+ Replaces the characters " .,;!?/'\()[]{}+*°" by an underscore.
+ </p>
+ <table>
+ <tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td>value</td>
+ <td>No</td>
+ <td>The string to be escaped.</td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ </body>
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org