History | Edit

The requirements of the Oxygen XML WebHelp plugin for the DITA Open Toolkit are as follows:
  • Java Virtual Machine 1.6 or newer if you want to use DITA-OT 1.8.5 or Java Virtual Machine 1.8 or newer if you want to use DITA-OT 2.5.2.
  • DITA Open Toolkit 1.8.5 or 2.5.2 (includes Saxon 9.x libraries).
    Note: The Oxygen XML WebHelp Plugin has only been tested with these two specific versions (DITA-OT 1.8.5 or DITA-OT 2.5.2). It is possible that the plugin may work with other versions, but only the two tested versions are supported.

To integrate the Oxygen XML WebHelp plugin with the DITA Open Toolkit, follow these steps:

  1. Download and install a Java Virtual Machine version compatible with the DITA-OT version.
  2. Download and unpack the DITA Open Toolkit version 1.8.5 or 2.5.2.
  3. Go to Oxygen XML WebHelp website, download the latest DITA-OT version of the installation kit, and unzip it.
  4. Copy all plugin directories from the unpacked archive to the plugins directory of the DITA OT distribution. This is necessary to enable certain functionality. For example, the com.oxygenxml.highlight directory adds syntax highlight capabilities to your WebHelp output for codeblock sections that contain source code snippets (XML, Java, JavaScript).
  5. If you have not already done so, copy your license key into a licensekey.txt file and place it in the DITA-OT-DIR/plugins/com.oxygenxml.webhelp.classic directory. Do the same for the Responsive variant: copy your license key into a licensekey.txt file and place it in the DITA-OT-DIR/plugins/com.oxygenxml.webhelp.responsive directory
  6. In the home directory of the DITA Open Toolkit, run the startcmd.bat script on Windows or startcmd.sh script on Linux/Mac OS X. In the displayed command line interface console, run ant -f integrator.xml.