Command-line tool parameters: All transformations
Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.
- basedir
- The directory where your project's ant build script resides. The DITA-OT will look for your .dita files relative to this directory. DITA-OT's default build script sets this as an attribute of the project, but you can also define it as a project property.
- cleantemp
- Specifies whether the DITA-OT deletes the files in the temporary directory after it finishes a build. The allowed values are yes and no; the default value is yes.
- debug
- Specifies whether debugging information is included in the log. The allowed values are yes and no; the default value is no.
- ditadir
- Specifies where the DITA-OT is installed.
- ditalocale
- Specifies the language locale file to use for sorting
index entries.Note: This parameter is not available for the XHTML transformation.
- draft
- Specifies whether the content of <draft-comment> and
<required-cleanup> elements is included in the output. The allowed values are
yes and no; the default value is
no. Corresponds to XSLT parameter
DRAFT in most XSLT modules.Tip: For PDF output, setting the args.draft parameter to yes causes the contents of the <titlealts> element to be rendered below the title.
- filter
- Specifies a filter file to be
used to include, exclude, or flag content.Note: Deprecated in favor of the args.filter parameter.
- grammarcache
- Specifies whether the
grammar-caching feature of the XML parser is used. The allowed values are
yes and no; the default value is
no.Note: 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 no.
- i
- Specifies the master file for your documentation project. 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.
- logdir
- Specifies the location where the DITA-OT places log files for your project.
- outdir
- Specifies the name and location of the output directory. By default, the output is written to DITA-dir\out.
- tempdir
- Specifies the location of the temporary directory. The temporary directory is where the DITA-OT writes temporary files that are generated during the transformation process.
- transtype
- Specifies the output format. 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
- wordrtf
- troff
- xhtml
- validate
- Specifies whether the DITA-OT validates the content. The allowed values are true and false; the default value is true.