Installing a DITA-OT Plugin
Edit online

Oxygen XML Editor 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).

Installing a DITA-OT Plugin

To install a DITA-OT plugin, following this procedure:
  1. Copy the additional plugin to the location of the DITA OT version you are using (by default, DITA-OT-DIR\plugins directory).
    Note: If the plugin is only supported in DITA-OT 2.5.4 version, make sure that you copy the plugin to the [OXYGEN_INSTALL_DIR]/frameworks/dita/DITA-OT2.x directory.
  2. 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).
  3. Select the Run DITA-OT Integrator transformation scenario. If the integrator is not visible, select the Show all scenarios option that is available in the Settings drop-down menu.
    Important: 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 plugin and your application is installed in the Program Files folder, you can start the Oxygen XML Editor plugin main executable with administrative rights for the integrator process to be able to modify resources in the DITA OT folder.
  4. Apply the scenario.
  5. Check the Results panel at the bottom of the application to make sure the build was successful.
Note: Starting with version 17.0, if the DITA-OT plugin declares a transtype (transformation type), Oxygen XML Editor plugin detects that transformation type declaration from the DITA OT plugin and presents descriptions in the DITA Transformation Type dialog box. Oxygen XML Editor 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.