Default values for externally modifiable parameters

This topic lists the default values for externally modifiable parameters.

These default values can be changed at run time by using the parameter-passing syntax of your XSLT processor (if it supports command-line parameters). If your processor does not support parameter-passing on the command line, copy the XSL directives you wish to change into an override XSLT stylesheet, change the values as needed, and import dita2htmlImpl.xsl at the top of this new stylesheet. dita2xhtml.xsl is an example of an override stylesheet that you can copy and modify as needed.

Parameter name Explanation Default value
dita-css Default CSS filename parameter, usually the name of your site's overall stylesheet. commonltr.css
bidi-dita-css Default CSS filename parameter for bi-direction language, usually the name of your site's overall stylesheet. commonrtl.css
CSS User's CSS filename parameter.

This can be the name of a stylesheet used by one or more topics within an overall group. This stylesheet can use the CSS cascade effect to modify existing properties or it can override or define new properties.

null
CSSPATH Default CSS path parameter.

This specifies a path for the cascading style sheet (CSS). This allows you to place the CSS in one place and have several different topics point to it. If no CSSPATH is specified, the CSS is assumed to be in the same directory as the XHTML.

null
HDF The name of the file which contains XHTML codes to be placed in the HEAD area. null
HDR The name of the file which contains XHTML codes to be placed in the BODY running-heading area. null
FTR The name of the file which contains XHTML codes to be placed in the BODY running-footing area. null
ARTLBL Default output artwork filenames processing parameter; no and yes are valid values; any other value is ignored. no
DRAFT Default hide draft & cleanup content processing parameter ( no= hide them); no and yes are valid values; any other value is ignored. no
INDEXSHOW Default hide index entries processing parameter ( no = hide them); no and yes are valid values; any other value is ignored. no
YEAR The year for the copyright. 2005l
OUTEXT Default output extension processing parameter; htm and html are valid values. html
WORKDIR The working directory, relative to the stylesheet, that contains the document being transformed. Needed as a directory prefix for the @conref and @href document() function calls. ./
PATH2PROJ The path back to the project. Used for c.gif, delta.gif, and .css files to allow users to have these files in 1 location. null
FILENAME The file name (file name and extension only - no path) of the document being transformed. Needed to help form debugging messages.
Note: This value is not inherent to the XSLT processor; typically, when the transform starts, the input filename will be passed to the processor's command line as a parameter. Any resulting debugging messages will echo the file name.
null
FILTERFILE The name of the file that contains filter/flagging/revision information. null
DBG Debug mode which enables XSL debugging XSL messages. Needed to help form debugging messages. no and yes are valid values; any other value is ignored. no
DITAEXT DITAEXT file extension name of dita topic file. null

For example, the following sample invocation shows how to turn on draft mode using the Saxon XSLT processor:

c:pkg\dita12\doc>java -jar <saxon_dir>/saxon.jar abc.htm 
        dita-tweaks.xml ..\xsl\dita2htmlImpl.xsl DRAFT=yes

The effect of this parameter will be to show the content of all <draft-comment> and <required-cleanup> elements with highly visible styling for use by reviewers.

Note: To invoke a process using parameters, please check the documentation for your XSLT processor. Most current XSLT 1.0 processors support a non-standard command line interface for parameters.
Note: Parametric tweaks cannot be applied from internal stylesheet links (that is, the <?xml-stylesheet ...?> processing instruction) as such associations do not provide a way to pass parameters, even if a browser-specific renderer is capable of using such data. To cause a browser-based view to show something ordinarily affected by a command-line parameter, such as the DRAFT="yes" effect, embed the alternative value directly in the override stylesheet that is named in the stylesheet processing instruction:
<xsl:param name="DRAFT" 
        select="'yes'"/>