Edit online

Installing a DITA-OT Plugin

Oxygen XML Editor Eclipse plugin comes bundled with various DITA-OT plugins, but the architecture of the DITA Open Toolkit also allows you to install additional plugins that can be found from various sources (for example, Oxygen's public GitHub repository includes some DITA-OT plugins).
CAUTION:
Oxygen XML Editor Eclipse plugin support engineers do not officially offer support and troubleshooting assistance for custom DITA-OT distributions or custom installed DITA-OT plugins. If you discover any issues or inconsistent behavior while using a custom DITA-OT or a DITA-OT that contains custom DITA-OT plugins, you should revert to the default built-in DITA-OT.

Installing a DITA-OT Plugin

To install a DITA-OT plugin, following this procedure:

  1. Locate the DITA Open Toolkit plugins directory where the plugin will be installed.

    To avoid making changes inside the Oxygen XML Editor Eclipse plugin installation folder, it is strongly recommended to download the Oxygen Publishing Engine that corresponds to your version of Oxygen XML Editor Eclipse plugin, copy it somewhere on your disk where you have full write access, and reference it in the Preferences > DITA page.

    The default DITA-OT-DIR is bundled inside the Oxygen XML Editor Eclipse plugin installation folder. If you want to install it directly there, the folder where the DITA-OT is located needs to have full write access permissions set to it. For example, in Windows, if you are integrating plugins in the DITA-OT folder bundled with Oxygen XML Editor Eclipse plugin and your application is installed in the Program Files folder, you can start the Oxygen XML Editor Eclipse plugin main executable with administrative rights for the integrator process to be able to modify resources in the DITA-OT folder.

  2. Copy the additional plugin to the location of the DITA-OT version you are using (by default, DITA-OT-DIR\plugins directory).
  3. Select the Configure Transformation Scenario(s) action from the DITA Maps Manager toolbar (you could also use the same action on the main toolbar or open the Transformation Scenarios view).
  4. Select the Integrate/Install DITA-OT Plugins transformation scenario. If the integrator is not visible, select the Show all scenarios option that is available in the Settings drop-down menu.
  5. Apply the scenario.
  6. Check the Results panel at the bottom of the application to make sure the build was successful.

After the installation, you can open a DITA map and use the Configure Transformation Scenarios dialog box to create a new DITA-OT transformation scenario. Oxygen XML Editor Eclipse plugin detects that transformation type declaration from the DITA-OT plugin and presents descriptions in the DITA Transformation Type dialog box. Oxygen XML Editor Eclipse plugin also shows the contributed parameters from the plugin in the transformation scenario's Parameters tab.

Tip:
You can declare the transformation type and allowed parameters by following the procedure found in: Defining the Transformation Type and Allowed Parameters in a DITA-OT Plugin.