From a51bfd7f6b0b5555a9130eb7a3b0bb13565eacc4 Mon Sep 17 00:00:00 2001 From: ltheussl Date: Wed, 21 Sep 2005 00:12:27 +0000 Subject: [PATCH] MPXDOC-169: Add xdoc tag library documentation to the plugin site git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@290590 13f79535-47bb-0310-9956-ffa450edef68 --- xdoc/xdocs/changes.xml | 1 + xdoc/xdocs/navigation.xml | 1 + xdoc/xdocs/tags.xml | 332 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 334 insertions(+) create mode 100644 xdoc/xdocs/tags.xml diff --git a/xdoc/xdocs/changes.xml b/xdoc/xdocs/changes.xml index 779affaa..563a6f2a 100644 --- a/xdoc/xdocs/changes.xml +++ b/xdoc/xdocs/changes.xml @@ -27,6 +27,7 @@ + Add xdoc tag library documentation to the plugin site. Fix xdoc:validate. One cannot call xdoc:copy-user-resources directly. Add support for more powered-by banners. diff --git a/xdoc/xdocs/navigation.xml b/xdoc/xdocs/navigation.xml index e3d018f9..8b15ee64 100644 --- a/xdoc/xdocs/navigation.xml +++ b/xdoc/xdocs/navigation.xml @@ -29,6 +29,7 @@ + diff --git a/xdoc/xdocs/tags.xml b/xdoc/xdocs/tags.xml new file mode 100644 index 00000000..e269b1d7 --- /dev/null +++ b/xdoc/xdocs/tags.xml @@ -0,0 +1,332 @@ + + + Plugin tags + + +
+

The following tag libraries and tags are provided by this plugin.

+
    +
  1. doc +
      +
    1. deregisterReport
      2. +
    2. registerReport
      3. +
    3. formatAsNumber
      4. +
    4. jslFile
      5. +
    5. jsl
      6. +
    6. itemLink
      7. +
    7. text-xdoc
      8. +
    8. printRow
      9. +
    9. performJSL
      10. +
    10. performJSLTransform
      11. +
    11. performJSL-i18n
      12. +
    12. jslToSite
      13. +
    13. escapeNameToken
      14. +
    +
    2. +
+
+
+ +

Deregister a report from xdoc.

+ + + + + + + +
AttributeOptional?Description
nameNo Report to deregister, must be same as name used to register.
+ + +

A tag to register a report with xdoc.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeOptional?Description
nameNoThe name of the report to register.
pluginNameNoThe name of the plugin. the plugin:report goal must exist
descriptionYesA text description of the report.
linkNoThe nav-bar link for this report.
targetYesThe target for the new page (_self, _blank, ...).
+ + +

Calls org.apache.maven.util.DVSLFormatter

+ + + + + + + + + + + + +
AttributeOptional?Description
stringNoThe string to format.
patternNoThe pattern.
+ + +

+ Basic tag for performing arbitrary jsl transformations + on arbitrary jsl inputs. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeOptional?Description
inputYesThe input file.
outputNoThe output file.
stylesheetNoThe stylesheet to use in the transformation.
encodingYesThe encoding of the output file.
omitXmlDeclarationYes
outputModeNo
prettyPrintYes
+ + +

+ This tag has a lot of defaults suitable for transforming + documents easily. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeOptional?Description
inputYesThe input file.
outputDirectoryYesWill be placed under ${maven.gen.docs}.
stylesheetNoThe stylesheet to use in the transformation.
encodingYesDefaults to ${maven.docs.outputencoding}.
omitXmlDeclarationYesDefaults to ${maven.docs.omitXmlDeclaration}.
outputModeNo
prettyPrintYes
+ + +

Used to generate the links in the navigation bar.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeOptional?Description
linkNoThe link URL.
relativePathYesThe relative path to the link location.
nameNoThe name of the link.
imgYesAn optional image to display instead of the link name.
stateYesexpanded | collapsed | none.
targetYes
+ + +

Wraps a text in a CDATA section.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeOptional?Description
outputNoThe output file.
titleYesThe title for the page.
sectionYesThe section heading.
encodingYesDefaults to ${maven.docs.outputencoding}.
preambleYesPlaced in paragraph block prior to text.
inputTextNoWill be wrapped in a CDATA, will not escape CDATA tags (as yet).
inputFileYesWill be read in and wrapped in CDATA. Overrides inputText if set.
+ + +

Alternator for row style in a table.

+ + +

+ Generates the JSL files on the given srcdir attribute depending on + the locale wanted. +

+ + + + + + + +
AttributeOptional?Description
srcdirNo + Input will be read from ${srcdir}/${locale} + and put into ${destdir}/${locale} for every locale + defined (except the default locale). +
+ + +

Generates the JSL files on the given srcdir attribute.

+ + + + + + + +
AttributeOptional?Description
srcdirNoThe input directory.
+ + +

Generates the JSL files on the given srcdir attribute.

+ + + + + + + + + + + + +
AttributeOptional?Description
srcdirNoThe input directory.
destdirNoThe output directory.
+ + +

+ Transforms files in the given dir using the site stylesheet and + navigation and place them in maven.docs.dest + (typically target/docs). +

+ + + + + + + +
AttributeOptional?Description
srcdirNoThe input directory.
+ + +

+ Escapes a string for generating a valid name token + (needed for "name" attribute in html anchors). + Replaces the characters " .,;!?/'\()[]{}+*°" by an underscore. +

+ + + + + + + +
AttributeOptional?Description
valueNoThe string to be escaped.
+ +
+ +