Command-line tool parameters: All HTML-based transformations

DITA Open Toolkit 1.8.4

previous page next page

Command-line tool parameters: All HTML-based transformations

Certain parameters apply to all the HTML-based transformation types: Eclipse content, Eclipse help, HTML Help, JavaHelp, TocJS, and XHTML.

Note: You must specify an absolute path as the value for the following parameters:
  • ftr
  • hdr
  • hdf
Table 1. Command-line tool parameters: All HTML-based transformations
Parameters Description
args.css Specifies the name of a custom .css file.
artlbl Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are yes and no; the default value is no.
copycss Specifies whether to copy the custom .css file to the output directory.
csspath Specifies the location of a copied .css file relative to the output directory. Corresponds to XSLT parameter CSSPATH.
cssroot Specifies the directory that contains the custom .css file. DITA-OT will copy the file from this location.
ftr Specifies an XML file that contains content for a running footer. Corresponds to XSLT parameter FTR.
Note: The XML file must contain valid XML. A common practice is to place all content into a <div> element.
generateouter Specifies whether to generate output files for content that is not located in or beneath the directory containing the DITA map file. The following values are supported:
  • 1 (default) – Do not generate output for content that is located outside the DITA map directory..
  • 2 – Generate output for the content that is located outside the DITA map directory.
  • 3 – Shift the output directory so that it contains all output for the publication.

See generate.outer.copy parameter for more information.
hdf Specifies an XML file that contains content to be placed in the document head.
hdr Specifies an XML file that contains content for a running header. Corresponds to the XSLT parameter HDR.
Note: The XML file must contain valid XML. A common practice is to place all content into a <div> element.
indexshow Specifies whether the content of <indexterm> elements are rendered in the output. The allowed values are yes and no; the default value is no.
onlytopicinmap Specifies whether files that are linked to, or referenced with a @conref attribute, generate output. If set to yes, only files that are referenced directly from the map will generate output.
outercontrol Specifies how the DITA OT handles content files that are located in or below the directory containing the master DITA map. The following values are supported:
  • fail – Fail quickly if files are going to be generated or copied outside of the directory
  • warn (default) – Complete the operation if files will be generated or copied outside of the directory, but log a warning
  • quiet – Quietly finish with only those files; do not generate warnings or errors.
The gen-list-without-flagging Ant task generates a harmless warning for content that is located outside the map directory; you can suppress these warnings by setting the property to quiet.
Warning: Microsoft HTML Help Compiler cannot produce HTML Help for documentation projects that use outer content. The content files must reside in or below the directory containing the master DITA map file, and the map file cannot specify ".." at the start of the @href attributes for <topicref> elements.
usetasklabels Specifies whether to generate headings for sections within task topics. The allowed values are YES and NO; the default value is NO. Corresponds to the XSLT parameter GENERATE-TASK-LABELS.
xhtmlclass Specifies whether to include the DITA class ancestry inside the XHTML elements .For example, the <prereq> element (which is specialized from section) would generate class="section prereq. The allowed values are yes and no; the default value is yes. Corresponds to the XSLT parameter PRESERVE-DITA-CLASS.
Note: Beginning with DITA OT release 1.5.2, the default value is yes. For release 1.5 and 1.5.1, the default value was no.
xsl Specifies a custom XSL file to be used instead of the default XSL transformation (xsl\dita2xhtml.xsl). The parameter must specify a fully qualified file name.
Parent topic: Command-line tool parameters
Related reference
Command-line tool parameters: Eclipse content transformation
Command-line tool parameters: Eclipse help transformation
Command-line tool parameters: HTML help transformation
Command-line tool parameters: JavaHelp transformation
Command-line tool parameters: XHTML transformation
previous page start next page