Ant parameter details

Ant parameter details All transformations All transformations Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.

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. 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.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 . 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.input.dir The default value is the parent directory of the file specified by args.input. 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". clean.temp dita.temp.dir The temporary directory is where the 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

This needs a better and longer description.

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. 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; the default value is . 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. output.dir By default, the output is written to DITA-dir/out. transtype You can create plug-ins to add new values for this parameter; by default, the following values are available:

docbook
eclipsehelp
eclipsecontent
html5
htmlhelp
javahelp
odt
pdf
wordrtf
troff
xhtml

HTML-based output formats All HTML-based transformations Certain parameters apply to all the HTML-based transformation types: Eclipse help, HTML Help, JavaHelp, TocJS, HTML5, and XHTML.

args.breadcrumbs Corresponds to the XSLT parameter BREADCRUMBS. args.csspath Corresponds to the XSLT parameter CSSPATH. DITA-OT will copy the file to this location. args.cssroot DITA-OT will copy the file from this location. 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. 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. 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. 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 . args.xsl The parameter must specify a fully qualified file name.

Eclipse content Eclipse content Certain parameters are specific to the Eclipse content transformation.

args.eclipsecontent.toc The toolkit ignores the value of this property when processing an Eclipse Collection Map, eclipse.dtd.

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.

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 HTML Help transformation.

JavaHelp JavaHelp Certain parameters are specific to the JavaHelp transformation.

args.javahelp.map

What does this mean? How does this differ from the args.input parameter? Or should this read "Specifies the name of the JavaHelp map file?

args.javahelp.toc Default value is the name of the ditamap file for your project. I assume that the first sentence means "Specifies the name of the JavaHelp TOC file." But what does the second sentence mean? That the default value for the args.javahelp.toc parameter is the name of the master DITA map? Or that the default value for the args.javahelp.toc parameter is the value of the args.javahelp.map parameter?

ODT ODT Certain parameters are specific to the ODT transformation.

Other parameters Other These parameters enable you to reload style sheets that the DITA-OT uses for specific pre-processing stages.

I've made no attempt to work with the content in the topic. Here's what I'd like to know:

When would someone want to use the various dita.preprocess parameters? (Other than if they need to reduce Java memory consumption.) The use cases are not clear from the current description.

PDF PDF Certain parameters are specific to the PDF transformation.

args.xsl.pdf You must specify the fully qualified file name. pdf.formatter The client package comes with Apache FOP; other XSL processors must be separately installed. 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.

HTML5 and XHTML HTML5 and XHTML Certain parameters are specific to the HTML5 and XHTML transformations.

args.xhtml.contenttarget The default value is . args.xhtml.toc.class Found in map2htmltoc.xsl.

HTML5 parameters HTML5 Certain parameters are specific to the HTML5 transformation.