Edit online

Installing WebHelp Responsive

The requirements of the Oxygen XML WebHelp Responsive plugin for the DITA Open Toolkit are as follows:
  • Java 17 or later.
  • DITA-OT 4.2.3 (includes Saxon 10.x libraries).
    Note:
    The Oxygen XML WebHelp Responsive plugin has only been tested with this specific version: (DITA-OT 4.2.3. It is possible for the plugin to 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 Java 17 or later.
  2. Download and unpack the DITA Open Toolkit version 4.2.3.
  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> elements 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:
    • Windows
    • Linux/macOS
    DITA-OT-DIR/bin/dita.bat --install
    sh DITA-OT-DIR/bin/dita --install
  7. To test the installation, initiate a publishing process by using one of the options found here: Generating WebHelp Responsive Output.