Integrating the Oxygen XML WebHelp Plugin with the DITA Open Toolkit
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.3.3.
- DITA Open Toolkit 1.8.5 or 2.3.3 (includes Saxon 9.x libraries).
Note
The Oxygen XML WebHelp Plugin has been tested with these two specific versions (DITA-OT 1.8.5 or DITA-OT 2.3.3) and therefore they are the recommended versions.
To integrate the Oxygen XML WebHelp plugin with the DITA Open Toolkit, follow these steps:
- Download and install a Java Virtual Machine version compatible with the DITA-OT version.
- Download and unpack the DITA Open Toolkit version 1.8.5 or 2.3.3.
- Go to Oxygen XML WebHelp website, download the latest installation kit, and unzip it.
- Copy all plugin directories from the unpacked archive to the
pluginsdirectory of the DITA OT distribution. This is necessary to enable certain functionality. For example, thecom.oxygenxml.highlightdirectory adds syntax highlight capabilities to your WebHelp output forcodeblocksections that contain source code snippets (XML, Java, JavaScript). - If you have not already done so, copy your license key into a
licensekey.txtfile and place it in theDITA_OT_DIR/plugins/com.oxygenxml.webhelpdirectory. - In the home directory of the DITA Open Toolkit, run
ant -f integrator.xml.