Installing a Plugin in the DITA Open Toolkit

The architecture of the DITA Open Toolkit allows additional plugins to be installed.

1. The additional plugin(s) should be copied to the DITA_OT_DIR\plugins directory.

   Note

   If the plugin is only supported in DITA-OT 2.3.3 version, make sure that you copy the plugin in the [OXYGEN_INSTALL_DIR]/frameworks/dita/DITA-OT2.x directory.
2. Run the predefined transformation scenario called Run DITA OT Integrator by executing it from the Apply Transformation Scenario(s) dialog box. If the integrator is not visible, enable the Show all scenarios action 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 if you are integrating plugins in the DITA OT folder bundled with Oxygen XML Editor plugin and if you are running on Windows 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.

   Starting with version 17.0, Oxygen XML Editor plugin detects the transformation type (transtype) declarations from DITA OT plugins and presents descriptions, which are contributed in the transtype declarations, in the DITA Transformation Type dialog box. Oxygen XML Editor plugin also shows the contributed parameters from DITA OT plugins in the Parameters tab in the Edit DITA Scenario dialog box.

3. 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 plugin that does not detect the transtype declarations), you can create a new DITA OT transformation scenario with a predefined type that is similar to the new transformation type. Then edit the transformation scenario, and in the Parameters tab add a transtype parameter with the value of the new transformation type.

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>