Running from Command Line
Edit online

To publish to the WebHelp Classic output from a command line outside of Oxygen XML Editor/Author, you can use the dita startup script that comes bundled with DITA Open Toolkit distribution.

Required Arguments for the dita Command Startup Script:

DITA-OT-DIR\bin\[executable] -i [path_to_input.ditamap] -f [transformation_type]

executable
Windows - The dita.bat script located in: DITA-OT-DIR\bin\.
Linux/Mac OS X - The dita script file located in: DITA-OT-DIR/bin/.
-i / -input
Specifies the master file for your DITA documentation project. Typically this is a DITA map.
-f / -format
Specifies the transformation type. The Oxygen XML WebHelp Plugin contributes the following transformation types for DITA:
  • webhelp - The transformation that produces WebHelp Classic output for desktop.
  • webhelp-feedback - The transformation that produces feedback-enabled WebHelp Classic with Feedback for desktop.

Additional Options or Parameters:

You can also use DITA-OT options to modify the command behavior or additional configuration parameters that are contributed by the Oxygen XML WebHelp Plugin.

DITA-OT-DIR\bin\[executable] -i [path_to_input.ditamap] -f [transformation_type] [option] -D[parameter=value]

Command Line Examples:
  • Windows: dita.bat -i c:\mySample.ditamap -f webhelp-responsive -o c:\output -Dwebhelp.logo.image=C:\images\myLogo.jpg
  • Linux/Mac OS X: dita -i /mySample.ditamap -f webhelp-responsive -o /output -Dwebhelp.logo.image=/images/myLogo.jpg