Running an External DocBook Transformation Using the WebHelp Plugin

To run a DocBook to WebHelp (webhelp, webhelp-feedback, webhelp-mobile) transformation using the Oxygen XML WebHelp plugin, use:
  • docbook.bat script file for Windows based systems.
  • docbook.sh script file for Unix/Linux based systems.
    Note: You can call these files in an automated process or from the command line.
The docbook.bat and the docbook.sh files are located in the home directory of the Oxygen XML WebHelp Plugin. Before using them to generate an WebHelp system, customize them to match the paths to the JVM, DocBook XSL distribution and Saxon engine, and also to set the transformation type. To do this, open a 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. You can set it to webhelp, webhelp-feedback and webhelp-mobile.
  • 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.