Apache Maven 1.x has reached its end of life, and is no longer supported. For more information, see the announcement. Users are encouraged to migrate to the current version of Apache Maven.

Overview

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

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

doc Tag Library

deregisterReport Tag

Deregister a report from xdoc.

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

registerReport Tag

A tag to register a report with xdoc.

AttributeOptional?Description
name No The name of the report to register. Used for navigation items.
pluginName No The name of the plugin. the plugin:report goal must exist
description Yes A text description of the report.
link Either the link or the externalLink attributes must be defined. The nav-bar link for this report. This link must be relative to the root directory of the documentation and it musn't contain the file suffix ('.html' for example).
fileSuffix Yes the file suffix to add to the link. '.html' by default. Used only if the link attribute is defined.
externalLink Either the link or the externalLink attributes must be defined. The nav-bar link for this report. This is a full url link (http://somewhere...).
target Yes The target for the new page (_self, _blank, ...).
image Yes The link to an image to display in the report entry in the navigation bar. This link must be relative to the root directory of the documentation.

formatAsNumber Tag

Calls org.apache.maven.util.DVSLFormatter

AttributeOptional?Description
string No The string to format.
pattern No The pattern.

jslFile Tag

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

AttributeOptional?Description
input Yes The input file.
output No The output file.
stylesheet No The stylesheet to use in the transformation.
encoding Yes The encoding of the output file.
omitXmlDeclaration Yes
outputMode No
prettyPrint Yes

jsl Tag

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

AttributeOptional?Description
input Yes The input file.
outputDirectory Yes Will be placed under ${maven.gen.docs}.
stylesheet No The stylesheet to use in the transformation.
encoding Yes Defaults to ${maven.docs.outputencoding}.
omitXmlDeclaration Yes Defaults to ${maven.docs.omitXmlDeclaration}.
outputMode No
prettyPrint Yes

itemLink Tag

Used to generate the links in the navigation bar, the breadcrumbs and the quick links.

AttributeOptional?Description
link No The link URL.
relativePath Yes The relative path to the link location.
name No The name of the link.
img Yes An optional image to display in addition to the name.
hideName Yes Set to true to hide the link's name (can be used to only display the image for example).
state Yes expanded | collapsed | none.
target Yes The same as in HTML. Used with frames to specify in which frame the link should be rendered. If _blank is used, an icon is displayed to show that a new window is opened by clicking on this link.

text-xdoc Tag

Wraps a text in a CDATA section.

AttributeOptional?Description
output No The output file.
title Yes The title for the page.
section Yes The section heading.
encoding Yes Defaults to ${maven.docs.outputencoding}.
preamble Yes Placed in paragraph block prior to text.
inputText No Will be wrapped in a CDATA, will not escape CDATA tags (as yet).
inputFile Yes Will be read in and wrapped in CDATA. Overrides inputText if set.

printRow Tag

Alternator for row style in a table.

performJSL Tag

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

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

performJSLTransform Tag

Generates the JSL files on the given srcdir attribute.

AttributeOptional?Description
srcdir No The input directory.

performJSL-i18n Tag

Generates the JSL files on the given srcdir attribute.

AttributeOptional?Description
srcdir No The input directory.
destdir No The output directory.

jslToSite Tag

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

AttributeOptional?Description
srcdir No The input directory.

escapeNameToken Tag

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

AttributeOptional?Description
value No The string to be escaped.