Ant processing parameters

The parameters are listed in alphabetical order. The names of required parameters are marked with an asterisk (*).

For examples of how these parameters are used in an Ant build script, see About Ant scripts.

Parameter (*Required), Target	Definition, Usage	Valid values, Default, Examples
args.artlbl These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Adds annotation to images showing the filename of the image. Useful for pre-publishing editing.	Valid: yes or no Default: no
args.copycss These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Whether to copy user-specified CSS file(s) to the directory specified {args.outdir}${args.csspath}.	Valid: yes or no Default: no
args.css These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Name of user-specified CSS file. Local or remote (web) file. If ${args.csspath} is a URL, ${args.css} must be a filepath relative to the URL.
args.csspath These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Path to user-specified CSS file. Notes: If ${args.csspath} is a URL, it must start with http:// or https://. Local absolute paths are not supported for args.csspath. Use "/" as the path separator, and do not append a "/" trailing separator (for example, use css/mycssfiles rather than css/mycssfiles/).	Default: no path Example: http://www.ibm.com/css
args.cssroot These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Root directory of user-specified CSS file. If this parameter is set, ${args.css} must be a filepath relative to args.cssroot.
args.dita.locale These targets only: htmlhelp and javahelp	Locale used for sorting indexterms. If no locale is specified, the first occurrence of "xml-lang" is used as the default locale.	Default (If "xml-lang" is not specified): en-us
args.draft All targets	Include draft and required cleanup content (that is, items identified as left to do before publishing).	Valid: yes or no Default: no
args.eclipsecontent.toc Target: eclipsecontent only	Root file name of the output Eclipse content toc file.	Default: name of the source ditamap file
args.eclipsehelp.toc Targets: eclipsehelp only	Root file name of the output Eclipse help toc file.	Default: name of the source ditamap file
args.eclipse.provider Targets: eclipsehelp only	Provider name of the Eclipse help output.	Default: DITA
args.eclipse.version Targets: eclipsehelp only	Version number of the Eclipse help output.	Default: 1.0
args.fo.img.ext Target: pdf only	Extension name of the image files in the PDF output. A given target set can contain only one or the other extension (not both). Image files with the non-specified extension will be renamed during the build process.
args.fo.output.rel.links Target: pdf only	Whether links will appear in the output files.	Valid: yes or no Default: no
args.fo.userconfig Target: pdf only	Name of the configuration file for FOP processing.	Valid: yes or no Default: no
args.ftr These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	URI of the file containing XHTML to be placed in the body running-footer area of the output file. The file must be well-formed XML.	Example: <property name="args.ftr" value="file:/C:/sandbox/myftr.xml"/>
args.hdf These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	URI of the file containing XHTML to be placed in the header area of the output file. The file must be well-formed XML.	Example: <property name="args.hdf" value="file:/C:/sandbox/myhdf.xml"/>.
args.hdr These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	URI of the file containing XHTML to be placed in the body running-header area of the output file. The file must be well-formed XML.	Example: <property name="args.hdr" value="file:/C:/sandbox/myhdr.xml"/>
args.htmlhelp.includefile Target: htmlhelp only	File to be included in the output.
args.indexshow These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Whether indexterm entries should display in the output text. Makes it possible to see what has been indexed in a pre-publishing review.	Valid: yes or no Default: no
*args.input All targets	Path and name of the input file. Use the same case as the filename.	Example: <property name="args.input" value="mastermap.ditamap"/>
args.javahelp.map Target: javahelp only	Root file name of the output JavaHelp map file.	Default: name of the input ditamap file
args.javahelp.toc Target: javahelp only	Root file name of the output JavaHelp toc file.	Default: name of the input ditamap file
args.outext These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml	Output file extension name for generated XHTML files. In most browser environments, either html or htm is acceptable.	Valid: html or htm Default: html
args.logdir All targets	Directory used to store generated Ant log files. If you generate several outputs in a single build, the following rules apply: If you specified a common logdir for all transformations, it will be used as the log directory. If you did not specify a common logdir for all transformations: If all individual transforms have the same output directory, it will be used as the log directory. If all individual transforms do not have the same output directory, basedir will be used as the log directory.	Default: output directory specified by output.dir
args.xhtml.toc Target: xhtml only	Root file name of the output XHTML toc file.	Default: index
args.xsl All targets except Eclipse content and troff	xsl transform file that will replace the default file: For transtype="docbook", dita2docbook.xsl will be replaced. For transtype="eclipsehelp" or transtype="xhtml": dita2xhtml.xsl. For transtype="html" or transtype="javahelp": dita2html.xsl. For transtype="pdf": dita2fo-shell.xsl. For transtype="rtf": dita2rtfImpl.xsl.	Example: <property name="args.input" value="mastermap.ditamap"/>
basedir All targets	Path of the working directory for transformations. Notes: If basedir is a relative path, it will be set relative to the current directory. For Ant scripts, the default is the path set in the Ant build file. For the Java command line, the default is the current directory.	Example: <project name="proj1" default="all" basedir="C:/ditaot"/>
clean.temp All targets	Whether to clean the temp directory before each build.	Valid: yes or no Default: no
dita.dir All targets	Absolute path of the Toolkit's home directory.
dita.extname All targets	File extension of the DITA source files. If you use extensions other than the default or the one you specify with this processing option (for example, .ditamap) you must specify the format attribute (for example, format="ditamap") in your source file references. If you don't, you will get an error message.	Default: .xml in release 1.2; .dita in release 1.3.1 Example: <property name="dita.extname" value=".dita"/>
dita.input.valfile All targets	Name of the ditaval file that contains filter/flagging/revision information.
dita.temp.dir All targets	Directory for the temporary files generated during the build.	Default: temp
*output.dir All targets	Path of the output directory.	Example: <property name="output.dir" value="${projdir}/out/xhtml"/>
*transtype All targets	Type of output to be produced.	Valid: docbook, eclipsecontent, eclipsehelp, htmlhelp, javahelp, pdf, troff, wordrtf, or xhtml Example: <property name="transtype" value="htmlhelp">

Parameter (*Required), Target

Definition, Usage

Valid values, Default, Examples

args.artlbl

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Adds annotation to images showing the filename of the image. Useful for pre-publishing editing.

Valid: yes or no

Default: no

args.copycss

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Whether to copy user-specified CSS file(s) to the directory specified {args.outdir}${args.csspath}.

Valid: yes or no

Default: no

args.css

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Name of user-specified CSS file. Local or remote (web) file.

If ${args.csspath} is a URL, ${args.css} must be a filepath relative to the URL.

args.csspath

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Path to user-specified CSS file.

Notes:

If ${args.csspath} is a URL, it must start with http:// or https://.
Local absolute paths are not supported for args.csspath.
Use "/" as the path separator, and do not append a "/" trailing separator (for example, use css/mycssfiles rather than css/mycssfiles/).

Default: no path

Example: http://www.ibm.com/css

args.cssroot

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Root directory of user-specified CSS file.

If this parameter is set, ${args.css} must be a filepath relative to args.cssroot.

args.dita.locale

These targets only: htmlhelp and javahelp

Locale used for sorting indexterms.

If no locale is specified, the first occurrence of "xml-lang" is used as the default locale.

Default (If "xml-lang" is not specified): en-us

args.draft

All targets

Include draft and required cleanup content (that is, items identified as left to do before publishing).

Valid: yes or no

Default: no

args.eclipsecontent.toc

Target: eclipsecontent only

Root file name of the output Eclipse content toc file.

Default: name of the source ditamap file

args.eclipsehelp.toc

Targets: eclipsehelp only

Root file name of the output Eclipse help toc file.

Default: name of the source ditamap file

args.eclipse.provider

Targets: eclipsehelp only

Provider name of the Eclipse help output.

Default: DITA

args.eclipse.version

Targets: eclipsehelp only

Version number of the Eclipse help output.

Default: 1.0

args.fo.img.ext

Target: pdf only

Extension name of the image files in the PDF output.

A given target set can contain only one or the other extension (not both). Image files with the non-specified extension will be renamed during the build process.

args.fo.output.rel.links

Target: pdf only

Whether links will appear in the output files.

Valid: yes or no

Default: no

args.fo.userconfig

Target: pdf only

Name of the configuration file for FOP processing.

Valid: yes or no

Default: no

args.ftr

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

URI of the file containing XHTML to be placed in the body running-footer area of the output file.

The file must be well-formed XML.

Example: <property name="args.ftr" value="file:/C:/sandbox/myftr.xml"/>

args.hdf

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

URI of the file containing XHTML to be placed in the header area of the output file.

The file must be well-formed XML.

Example: <property name="args.hdf" value="file:/C:/sandbox/myhdf.xml"/>.

args.hdr

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

URI of the file containing XHTML to be placed in the body running-header area of the output file.

The file must be well-formed XML.

Example: <property name="args.hdr" value="file:/C:/sandbox/myhdr.xml"/>

args.htmlhelp.includefile

Target: htmlhelp only

File to be included in the output.

args.indexshow

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Whether indexterm entries should display in the output text. Makes it possible to see what has been indexed in a pre-publishing review.

Valid: yes or no

Default: no

*args.input

All targets

Path and name of the input file.

Use the same case as the filename.

Example: <property name="args.input" value="mastermap.ditamap"/>

args.javahelp.map

Target: javahelp only

Root file name of the output JavaHelp map file.

Default: name of the input ditamap file

args.javahelp.toc

Target: javahelp only

Root file name of the output JavaHelp toc file.

Default: name of the input ditamap file

args.outext

These targets only: eclipsehelp, htmlhelp, javahelp, or xhtml

Output file extension name for generated XHTML files.

In most browser environments, either html or htm is acceptable.

Valid: html or htm

Default: html

args.logdir

All targets

Directory used to store generated Ant log files.

If you generate several outputs in a single build, the following rules apply:

If you specified a common logdir for all transformations, it will be used as the log directory.
If you did not specify a common logdir for all transformations:
- If all individual transforms have the same output directory, it will be used as the log directory.
- If all individual transforms do not have the same output directory, basedir will be used as the log directory.

Default: output directory specified by output.dir

args.xhtml.toc

Target: xhtml only

Root file name of the output XHTML toc file.

Default: index

args.xsl

All targets except Eclipse content and troff

xsl transform file that will replace the default file:

For transtype="docbook", dita2docbook.xsl will be replaced.
For transtype="eclipsehelp" or transtype="xhtml": dita2xhtml.xsl.
For transtype="html" or transtype="javahelp": dita2html.xsl.
For transtype="pdf": dita2fo-shell.xsl.
For transtype="rtf": dita2rtfImpl.xsl.

Example: <property name="args.input" value="mastermap.ditamap"/>

basedir

All targets

Path of the working directory for transformations.

Notes:

If basedir is a relative path, it will be set relative to the current directory.
For Ant scripts, the default is the path set in the Ant build file.
For the Java command line, the default is the current directory.

Example: <project name="proj1" default="all" basedir="C:/ditaot"/>

clean.temp

All targets

Whether to clean the temp directory before each build.

Valid: yes or no

Default: no

dita.dir

All targets

Absolute path of the Toolkit's home directory.

dita.extname

All targets

File extension of the DITA source files.

If you use extensions other than the default or the one you specify with this processing option (for example, .ditamap) you must specify the format attribute (for example, format="ditamap") in your source file references. If you don't, you will get an error message.

Default: .xml in release 1.2; .dita in release 1.3.1

Example: <property name="dita.extname" value=".dita"/>

dita.input.valfile

All targets

Name of the ditaval file that contains filter/flagging/revision information.

dita.temp.dir

All targets

Directory for the temporary files generated during the build.

Default: temp

*output.dir

All targets

Path of the output directory.

Example: <property name="output.dir" value="${projdir}/out/xhtml"/>

*transtype

All targets

Type of output to be produced.

Valid: docbook, eclipsecontent, eclipsehelp, htmlhelp, javahelp, pdf, troff, wordrtf, or xhtml

Example: <property name="transtype" value="htmlhelp">