Ant parameter details All transformations All transformations Certain parameters apply to all transformations that DITA Open Toolkit supports.
args.draft Corresponds to the XSLT parameter DRAFT in most XSLT modules.For PDF output, setting the args.draft parameter to causes the contents of the titlealts element to be rendered below the title. titlealts XSLT draft args.draft PDF PDF draft parameters args.draft args.figurelink.style Specifying results in "Figure 5"; specifying results in the title of the figure. Corresponds to the XSLT parameter FIGURELINK.Support for PDF was added in DITA-OT 2.0. By default PDF uses the value , which is not supported for other transformation types; this results in "Figure 5. Title". args.filter

Specifies filter file(s) used to include, exclude, or flag content. Relative paths are resolved against the DITA-OT base directory (for backwards compatibility) and internally converted to absolute paths.

To specify multiple filter files, use the system path separator character to delimit individual file paths (semicolon ‘;’ on Windows, and colon ‘:’ on macOS and Linux) and wrap the value in quotes:

--args.filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"

DITAVAL files are evaluated in the order specified, so conditions specified in the first file take precedence over matching conditions specified in later files, just as conditions at the start of a DITAVAL document take precedence over matching conditions later in the same document.

DITAVAL args.filter DITAVAL filters DITAVAL profiling OS X macOS macOS delimiter Linux delimiter Windows delimiter args.gen.task.lbl Corresponds to the XSLT parameter GENERATE-TASK-LABELS. args.grammar.cache This option dramatically speeds up processing time. However, there is a known problem with using this feature for documents that use XML entities. If your build fails with parser errors about entity resolution, set this parameter to . processing time args.input Typically this is a DITA map, however it also can be a DITA topic if you want to transform a single DITA file. The path can be absolute, relative to args.input.dir, or relative to the directory where your project’s Ant build script resides if args.input.dir is not defined. args.rellinks

For PDF output, the default value is . For all other formats, the default value is . args.rellinks PDF related links args.rellinks HTML5 related links args.rellinks

args.tablelink.style Specifying results in "Table 5"; specifying results in the title of the table. Corresponds to the XSLT parameter TABLELINK.Support for PDF was added in DITA-OT 2.0. By default PDF uses the value , which is not supported for other transformation types; this results in "Table 5. Title". tables args.tablelink.style clean.temp default.language Specifies the language that is used if the input file does not have the xml:lang attribute set on the root element. By default, this is set to . The allowed values are those that are defined in IETF BCP 47, Tags for Identifying Languages. xml:lang IETF BCP 47 languages default dita.temp.dir The temporary directory is where DITA-OT writes temporary files that are generated during the transformation process. dita.input.valfile Deprecated in favor of the args.filter parameter. filter-stage Changing the filtering stage may produce different results for the same initial data set and filtering conditions. force-unique

Setting this to ensures that unique output files are created for each instance of a resource when a map contains multiple references to a single topic.

 generate-debug-attributes Disabling debugging attributes reduces the size of temporary files and thus reduces memory consumption. However, the log messages no longer have the source information available and thus the ability to debug problems might deteriorate. debugging generate-debug-attributes memory generate.copy.outer generate.copy.outer

See for more information.

 onlytopic.in.map If set to , only files that are referenced directly from the map will generate output. outer.control 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. topicref href output.dir By default, the output is written to DITA-dir/out. result.rewrite-rule.class The custom class should implement the org.dita.dost.module.RewriteRule interface. result.rewrite-rule.class result.rewrite-rule.xsl See for details. result.rewrite-rule.xsl root-chunk-override Acceptable values include any value normally allowed on the chunk attribute. If the map does not have a chunk attribute, this value will be used; if the map already has a chunk attribute specified, this value will be used instead. chunk root-chunk-override store-type

For more information, see .

Custom plug-ins that expect to find certain files on disk in the temporary directory will not work with in-memory processing. transtype

HTML-based output parameters HTML-based output Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML Help, and Eclipse help. HTML5 parameters
args.copycss
If an external process will copy your custom .css file to the output directory, leave this parameter unset (or set it to ). If DITA-OT should copy the file when generating output, set it to .
 args.css
The value of this parameter should be only the file name. The absolute path to the parent directory should be specified with args.cssroot.
 args.csspath
Specifies the destination directory to which .css files are copied (relative to the output directory).

Corresponds to the XSLT parameter CSSPATH.

DITA-OT will copy the file to this location.

If args.csspath is not set, the custom CSS file (and the default CSS files) will be copied to the root level of the output folder. To copy CSS files to an output subfolder named css, set args.csspath to . CSS copy to specific location
args.cssroot
Specifies the source directory that contains the custom .css file.

DITA-OT will copy the file from this location.

Enter the absolute path to the parent directory of the custom CSS file specified with args.css.
args.dita.locale This parameter is not available for the XHTML transformation. args.ftr
Corresponds to the XSLT parameter FTR. The footer file should be specified using an absolute path and must contain valid XML. A common practice is to place all content into a div element. In HTML5 output, the footer file contents will be wrapped in an HTML5 footer element with the role attribute set to . div HTML footer args.ftr role HTML5 footers
args.gen.default.meta
Corresponds to the XSLT parameter genDefMeta.
args.hdf

The contents of the header file will be inserted in the head element of the generated HTML files.

The header file should be specified using an absolute path and must contain valid XML. If you need to insert more than one element into the HTML page head, wrap the content in a div element. The division wrapper in the header file will be discarded when generating HTML files, and the contents will be inserted into each page head. div HTML head args.hdf
args.hdr
Corresponds to the XSLT parameter HDR. The header file should be specified using an absolute path and must contain valid XML. A common practice is to place all content into a div element. In HTML5 output, the contents of the header file will be wrapped in an HTML5 header element with the role attribute set to . div HTML header args.hdr header role HTML5 headers
args.hide.parent.link deprecated features args.hide.parent.link
Corresponds to the XSLT parameter NOPARENTLINK. This parameter is deprecated in favor of the args.rellinks parameter.
args.outext
Corresponds to the XSLT parameter OUTEXT.
args.xhtml.classattr For example, the prereq element (which is specialized from section) would generate class="section prereq". Corresponds to the XSLT parameter PRESERVE-DITA-CLASS.Beginning with DITA-OT release 1.5.2, the default value is . For release 1.5 and 1.5.1, the default value was . prereq section args.xsl
The parameter must specify a fully qualified file name.
Eclipse help Eclipse help Certain parameters are specific to the Eclipse help transformation.
args.eclipsehelp.country For example, , , and would clarify a value of set for the args.eclipsehelp.language parameter. The content will be moved into the appropriate directory structure for an Eclipse fragment.What does "The content will be moved into the appropriate directory structure for an Eclipse fragment" mean? args.eclipsehelp.language This parameter is a prerequisite for the args.eclipsehelp.country parameter. The content will be moved into the appropriate directory structure for an Eclipse fragment. args.eclipse.provider The default value is . The toolkit ignores the value of this parameter when it processes an Eclipse map. args.eclipse.version The default value is .The toolkit ignores the value of this parameter when it processes an Eclipse map. args.eclipse.symbolic.name The id value from the DITA map or the Eclipse map collection (Eclipse help specialization) is the symbolic name for the plugin in Eclipse. The default value is .The toolkit ignores the value of this parameter when it processes an Eclipse map. id args.eclipse.symbolic.name I'm not clear what this means. Is the default value for the args.eclipse.symbolic.name parameter the value of the id attribute on the map or plugin element, if provided, and the if there is not a value for the id attribute or the args.eclipse.symbolic.name parameter?
HTML Help HTML Help Certain parameters are specific to the Microsoft Compiled HTML Help (.chm) transformation. PDF PDF Certain parameters are specific to the PDF transformation.
args.xsl.pdf You must specify the fully qualified file name. org.dita.index.skip

Up until DITA-OT 3.4, indexing code was provided in the PDF plug-in and only available for PDF output. In version 3.4 and above, indexing is provided by a separate plug-in to allow other transformations to access the results.

If you have overridden PDF index processing via the transform.topic2fo target in the past, you can set the org.dita.index.skip property to and re-enable the transform.topic2fo.index target with feature extension="depend.org.dita.pdf2.index" value="transform.topic2fo.index"/ in your plug-in configuration.

 org.dita.pdf2.i18n.enabled

Enables internationalization (I18N) font processing to provide per-character font selection for FO renderers that do not support the font-selection-strategy property (such as Apache FOP). Apache FOP I18N FOP Apache FOP I18N org.dita.pdf2.i18n.enabled fonts PDF

When this feature is enabled, DITA-OT uses a font mapping process that takes the content language into consideration. The mapping process uses configuration files for each language to define characters that should be rendered with certain logical fonts, and font mappings that associate each logical font to physical font files.

The following values are allowed:

  • (default) — Enables font mapping
  • — Disables font mapping
If you don’t use custom character mappings, turning off font mapping makes it easier to define custom fonts simply by changing font names in the XSL attributes files of your custom PDF plug-in. For details, see . outputFile.base By default, the PDF file uses the base filename of the input .ditamap file. DITA maps PDF file name pdf.formatter The client package comes with Apache FOP; other XSL processors must be separately installed. Apache FOP pdf.formatter formatter PDF formatter publish.required.cleanup deprecated features publish.required.cleanup The default value is the value of the args.draft parameter. Corresponds to the XSLT parameter publishRequiredCleanup.This parameter is deprecated in favor of the args.draft parameter.
XHTML Certain parameters are specific to the XHTML transformation.
args.xhtml.contenttarget The default value is . Change this value to use a different target name for the table of contents. table of contents XHTML
HTML5 parameters HTML5 The HTML5 transformation shares common parameters with other HTML-based transformations and provides additional parameters that are specific to HTML5 output. HTML5
args.copycss
args.css
args.csspath
args.cssroot
args.ftr
args.gen.default.meta
args.hdf
args.hdr
args.hide.parent.link deprecated features args.hide.parent.link
args.outext
args.xsl
nav-toc

Specifies whether to generate a table of contents (ToC) in the HTML5 nav element of each page. The navigation can then be rendered in a sidebar or menu via CSS. HTML5 nav-toc

The following values are supported:

  • (default) – No table of contents will be generated
  • – Include the current topic in the ToC along with its parents, siblings and children
  • – Generate a complete ToC for the entire map
table of contents HTML5 table of contents nav-toc