Running from Command Line

Edit online

To run a DocBook to WebHelp transformation outside of Oxygen XML Editor/Author, use the following script file:

• Windows - [DocBook XSL directory]\com.oxygenxml.webhelp.classic\docbook.bat
• Linux/Mac OS X - [DocBook XSL directory]/com.oxygenxml.webhelp.classic/docbook.sh

Before running the script to generate output, you must customize it to specify various paths and transformation type. To do this, open the script file and edit the following variables:

• JVM_INSTALL_DIR - Specifies the path to the Java Virtual Machine installation directory on your disk.
• ANT_INSTALL_DIR - Specifies the path to the installation directory of Ant.
• SAXON_6_DIR - Specifies the path to the installation directory of Saxon 6.5.5.
• SAXON_9_DIR - Specifies the path to the installation directory of Saxon 9.1.0.8.
• DOCBOOK_XSL_DIR - Specifies the path to the installation directory of the DocBook XSL distribution.
• TRANSTYPE - Specifies the type of the transformation you want to apply. The Oxygen XML WebHelp Plugin contributes the following transformation types for DocBook:
  • webhelp - The transformation that produces WebHelp Classic output for desktop.
  • webhelp-feedback - The transformation that produces feedback-enabled WebHelp Classic with Feedback for desktop.
• INPUT_DIR - Specifies the path to the input directory, containing the input XML file.
• XML_INPUT_FILE - Specifies the name of the input XML file.
• OUTPUT_DIR - Specifies the path to the output directory where the transformation output is generated.
• DOCBOOK_XSL_DIR_URL - Specifies the path to the directory of the DocBook XSL distribution in URL format.