Arguments and options for the <cmdname>dita</cmdname> command

Usage

To convert content from one format to another, specify the file to transform and the desired output format. If necessary, you can set additional configuration parameters with options.

dita --input = file --format = name options dita --project = file options Most dita command options support several syntax alternatives. All options can be specified with a GNU-style option keyword preceded by two hyphens. In many cases, Unix-style single-letter options (preceded by a single hyphen) are also available for brevity and backwards compatibility.

The dita command also supports a series of subcommands that can be used to manage plug-ins, or print information about the current configuration or version.

dita deliverables file dita install ID URL file dita plugins dita transtypes dita uninstall ID dita version Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax, which is still supported for backwards compatibility. (For example, dita --install will still work.)

Arguments --input -i --format -f

Each transformation requires you to specify at least the file to transform and the desired output format.

--input=file -i file Specifies the master file for your documentation project. This argument corresponds to the common parameter 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 current directory if args.input.dir is not defined. --format=name -f name This argument corresponds to the common parameter transtype. To list the formats that are currently available in your environment, use dita transtypes.

Subcommands deliverables subcommand install subcommand --install

install subcommand

uninstall subcommand --uninstall

uninstall subcommand

plugins subcommand --plugins

plugins subcommand

transtypes subcommand --transtypes

transtypes subcommand

--help -h version subcommand --version

version subcommand

deliverables file Show a list of the available deliverables in the specified project file. install { ID | URL | file } --install={ ID | URL | file } Install a single plug-in ID from the registry at (or a local registry), from a remote URL, or a local ZIP file. install --install uninstall ID --uninstall=ID

Remove the plug-in with the specified ID.

For a list of the currently installed plug-in IDs, use dita plugins. plugins --plugins Show a list of the currently installed plug-ins. transtypes --transtypes Show a list of the available output formats (transformation types). The entries in this list may be passed as values to the --format argument. version --version Print version information and exit.

Options -o --output --filter --force --temp -t --verbose -v --debug -d --logfile -l --parameter -D --propertyfile Java classes debugging dita command --debug -d Debug logging prints considerably more additional information. The debug log includes all information from the verbose log, plus details on Java classes, additional Ant properties and overrides, preprocessing filters, parameters, and stages, and the complete build sequence. Debug logging requires additional resources and can slow down the build process, so it should only be enabled when further details are required to diagnose problems. --output=dir -o dir

Specifies the path of the output directory; the path can be absolute or relative to the current directory.

This argument corresponds to the common parameter output.dir. By default, the output is written to the out subdirectory of the current directory.

--filter=files Specifies filter file(s) used to include, exclude, or flag content.

This argument corresponds to the common parameter args.filter. Relative paths are resolved against the current directory 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:

--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.

--force Force-install an existing plug-in. Passed as an additional option to the installation subcommand: dita install plug-in-zip --force --help -h Print a list of available arguments, options, and subcommands. --logfile=file -l file Write logging messages to a file. --parameter=value -Dparameter=value Specify a value for a DITA-OT or Ant build parameter.

The GNU-style --parameter=value form is only available for parameters that are configured in the plug-in configuration file; the Java-style -D form can also be used to specify additional non-configured parameters or set system properties.

Parameters not implemented by the specified transformation type or referenced in a .properties file are ignored.

--propertyfile=file Use build parameters defined in the referenced .properties file.

Build parameters specified on the command line override those set in the .properties file.

--resource=file -r file Process input with additional resources.

For example, to process a single topic file with a map that contains key definitions, use a command like this: dita --input=topic.dita --resource=keys.ditamap --format=

--temp=dir -t dir This argument corresponds to the common parameter dita.temp.dir. --verbose -v Verbose logging prints additional information to the console, including directory settings, effective values for Ant properties, input/output files, and informational messages to assist in troubleshooting.