Doxsl Processor For Ant

Doxsl includes a set of Ant build files that allow you to generate your XSLT stylesheet documentation through an automated process. To execute the build file, enter the following command:

ant -f $DOXSL-HOME/tools/ant/build.xml -Dinput.stylesheet=your_stylesheet_path -Doutput.format=format_name
        

Required Parameters

input.stylesheetThe path to the XSLT stylesheet that will be processed.
output.format Specifies the target Doxsl processor implementation. Values include dita, and docbook. This is dependent on which Doxsl implementations are installed.

Prerequisites

The build file was tested against Ant version 1.7.0. Earlier versions of Ant may also work but have not been tested.

The build files use Saxon 9 (or higher) libraries to generate your documentation set. The latest version includes a custom Ant task that can be integrated into the build process. Download the latest version of the Java libraries and install these on your local file system.

Conifiguration

Additionally, there is a separate properties file (doxsl-ant.properties) that holds all of the properties necessary for generating your output. The two important properties are saxon.lib.dir, and saxon.basename. Also included are properties that will be passed as parameters to the Saxon processor. These properties are prefixed with doxslparam to distinguish these properties from others. You can also set these on the command line using the -Dproperty_name=value pattern when invoking Ant

Property NameDescription
saxon.lib.dir This is the directory where you installed the Saxon libraries. By default it looks in current directory ($DOXSL-HOME/tools/ant
saxon.basename This is the basename of the core Saxon jar file. For example if the core Saxon jar file is named Saxon9.jar, the basename is Saxon9
doxsl.home This is the Doxsl root directory. By default it is set to ../..
doxslparam.application.name Sets the Application Name in the generated output via the application.name parameter in the Doxsl processor. Default value is XSLT Application
doxslparam.display.stylesheet.code Sets the display.stylesheet.code parameter in the Doxsl processor. This parameter is used to specify if the processor implementation should render the xsl:stylesheet code in the final output. Valid values are 0 or 1. By default it is set to 0 (false)
doxslparam.display.template.code Sets the display.template.code parameter in the Doxsl processor. This parameter is used to specify if the processor implementation should render the xsl:template in the output. Valid values are 0 or 1. By default it set to 0 (false).
doxslparam.display.attribute-set.code Sets the display.attribute-set.code parameter in the Doxsl processor. This parameter is used to specify if the processor implementation should render the xsl:attribute in the output. Valid values are 0 or 1. By default it is set to 0 (false).
doxslparam.display.function.code Sets the display.function.code parameter in the Doxsl processor. This parameter is used to specify if the processor implementation should render the xsl:function in the output. Valid values are 0 or 1. By default it is set to 0 (false).
doxslparam.display.param.code Sets the display.param.code parameter in the Doxsl processor. This parameter is used to specify if the processor implementation should render the xsl:param in the output. Valid values are 0 or 1. By default it is set to 1 (true).
doxslparam.lang Sets the locale that will be used to reference any generated text. By default it is set to en-us.
doxslparam.log.level Sets the logging level for any transform messages. Valid values are:
  • debug
  • info
  • status
  • warning
  • error
The default value is debug
Note:
Each output specific build may have additional properties that will be passed to the underlying Doxsl processor implementation.