Documentation Center

Build DITA output using DITA-OT and webworks

The batch file DITA-OT-WEBWORKS.cmd is responsible for launching the DITA Open Toolkit when using an output format which has the transtype property set to webworks.

ParameterDescription
Working directoryThe path of the working directory for transformations, it is the base of relative paths specified by other parameters.
Input fileThe path and name of the input file. This argument is case sensitive; case must match case on the filesystem.
Output DirectoryThe path of the output directory.
Transformation typeThe transformation type (output format) as selected in the user interface.
DraftAn indicator whether or not the draft-comment (and required-cleanup) element need to be preserved/rendered in the output.
CleanupAn indicator whether or not the temp location used (and created by DITA-OT) needs to be cleaned/removed at the end of the DITA-OT process
ValidateAn indicator whether or not DITA-OT needs to validate the intermediate topics/ditamaps against the DITA, assuring valid DITA content.
StationaryWebWorks stationary to be used by the webworks transformation type within DITA Open Toolkit. The filename needs to be referenced as an absolute filepath. By default the file will exist in the following location App<project-suffix>\Utilities\webworks\<stationery specific directory>\*.wxsp
TargetWebWorks target to be used by the webworks transformation type within DITA Open Toolkit. The target name to be used for this output format.
The DITA-OT-WEBWORKS.cmd launches DITA-OT using the Ant command line interface using the following parameters:
"ant" 
-Dtranstype=%4 
-Dargs.input=%1/%2 
-Doutput.dir=%3 
-Ddita.temp.dir=%1/temp 
-Dargs.draft=%5 
-Dclean.temp=%6 
-Dvalidate=%7 
-Dargs.stationery=%8 
-Dargs.target=%9
-Dargs.logdir=%3 
-logfile %3/%2_%4.log

with 
			%1: Working directory
			%2: Input file
			%3: Output directory
			%4: Transformation type
   %5: Draft parameter. Either "yes" or "no"
   %6: Clean temp location of DITA-OT process. Either "yes" or "no"
   %7: Validate DITA content against DITA DTD. Either "true" or "false"
   %8: Filepath pointing to the WebWorks stationary file (*.wxsp ) to be used by the Webworks.
   %9: Target to be used by the Webworks.

Result

The requested output is saved to the output directory (%3, or as shown above, specified in the third parameter for outdir).