Installing WebHelp Responsive
Edit online

The requirements of the Oxygen XML WebHelp Responsive plugin for the DITA Open Toolkit are as follows:
  • Java Virtual Machine 1.8 or newer required by DITA-OT 3.2.1.
  • DITA-OT 3.2.1 (includes Saxon 9.x libraries).
    Note: The Oxygen XML WebHelp Responsive plugin has only been tested with this specific version: (DITA-OT 3.2.1. It is possible that the plugin may work with other versions, but only this version is fully supported.

To install and integrate the Oxygen XML WebHelp Responsive plugin with the DITA-OT, 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 3.2.1.
  3. Go to Oxygen XML WebHelp website, download the latest DITA-OT version of the Oxygen XML WebHelp Responsive plugin 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. Register your license key.
  6. In the DITA-OT-DIR/bin directory of the DITA-OT, run one of the following scripts, depending on your operating system:
  7. To test the installation, initiate a publishing process by using one of the options found here: Generating WebHelp Responsive Output.