Edit online

Oxygen XML Editor 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 and your application is installed in the Program Files folder, you can start the Oxygen XML Editor 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.

Details About the Transformation Type (transtype)

Starting with version 17.0, if the DITA-OT plugin declares a transtype (transformation type), Oxygen XML Editor detects that transformation type declaration from the DITA OT plugin and presents descriptions (contributed in the transtype declarations) in the DITA Transformation Type dialog box. Oxygen XML Editor also shows the contributed parameters from the DITA OT plugin in the transformation scenario's Parameters tab.

If the plugin contributed a new transformation type that is not detected (for instance, if you are using a previous version of Oxygen XML Editor that does not detect the transtype declarations), you can set the transformation type by following this procedure:
  1. Create a new DITA OT transformation scenario with a predefined type that is similar to the new transformation type.
  2. Edit the transformation scenario and in the Parameters tab, add a transtype parameter with the value of the new transformation type. Click OK to save your changes.
    Note: A transformation type can also extend another transtype. For example, the pdf-prince transtype extends a commons transformation type that contains all the common DITA OT parameters.
    Example:
    <plugin id="com.oxygenxml.pdf.prince">
      <!-- extensions -->
      <feature extension="dita.conductor.transtype.check" value="pdf-prince"
     type="txt"/>
      <feature extension="dita.conductor.target.relative" value="integrator.xml"
     type="file"/>  
      <feature extension="dita.transtype.print" value="pdf-prince"/>
      <transtype name="pdf-prince"extends="commons" desc="PDF (Prince XML)">
        <param name="princeExecPath" type="file" desc="Path to the Prince executable
     file that will produce the PDF"/>
      </ Transtype>
    </plugin>