Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Initial DITA Configuration DITA Administration DITA Setup Installing DITA-OT

Installing DITA-OT

Prerequisites:

Match the DITA-OT documentation version to your working version by toggling the version drop-down on the DITA-OT website.

Version Notes: CMS 10.6.492 vs. CMS 10.6.308–10.6.378
Plugin installation requirements differ between CMS 10.6.492 and CMS 10.6.308–10.6.378.

For all CMS 10.6 versions, the plugin.xml must reside in the root folder of the plugin .zip file.

CMS 10.6.492: The CMS requires that the plugin.xml root <plugin /> element has an @id attribute. The CMS does not require plugin.xml to have a transtype definition.

CMS 10.6.308–10.6.378: The CMS requires the plugin.xml to include the transtype definition. If you need to upload a plugin that does not have a transtype definition, system administrators review DITA-OT: Installing plugin-ins for details to install the plugin using the command line.

The CMS uses the DITA Open Toolkit (DITA-OT) publishing engine to run transformations for DITA publishing and preview. Choose the DITA-OT version that best meets your organization's publishing requirements.

To install the DITA Open Toolkit:
  1. Navigate to Administration > DITA > Setup.
  2. Select the Open Toolkit Setup header bar to expand the area.

    DITA Open Toolkit Setup

  3. Select the Install DITA-OT drop-down menu, then choose your preferred DITA-OT version:

    • Ingeniux CMS version:

      Ingeniux CMS provides an enhanced DITA-OT version with custom plugins and bug fixes based on version 3.6.1. Use this recommended version unless your organization requires a different DITA-OT version.

      1. Select Ingeniux DITA-OT 3.6.1 (Recommended Version) from the list.

        The Install DITA Open Toolkit dialog displays.

      2. In the Install DITA Open Toolkit dialog, select Install to verify that the chosen version is correct.

    • Community versions:

      Process your DITA content with using a community version of the DITA-OT.

      1. Select your preferred DITA-OT version from the list.

        The Install DITA Open Toolkit dialog displays.

      2. In the Install DITA Open Toolkit dialog, select Install to verify that the chosen version is correct.

    • Custom version:

      Install your own custom version of the DITA-OT.

      1. Select Install Custom DITA-OT from the list.

        The Install DITA Open Toolkit dialog displays.

      2. In the Install DITA Open Toolkit dialog, select Install to verify that you want to install a custom DITA Open Toolkit version.

        The Install Custom OT dialog displays.

      3. In the Install Custom OT dialog, either drag your custom DITA-OT into the dialog from your file system, or click the center of the dialog to browse for it.

      4. Select Upload.

    The CMS installs your selected DITA-OT version. The DITA Open Toolkit Setup header displays the currently installed DITA-OT version, and the System Plugins list displays available plugins installed with the DITA-OT.

    DITA Open Toolkit Setup

  4. Upload additional plugins to your DITA-OT installation using these steps:
    1. Select the Add Plugin button.
      The Upload DITA Open Toolkit Plugins dialog displays.
    2. Either drag the new plugin into the dialog from your file system, or click the center of the dialog to browse for it.
      Important
      Transtype @name values for custom normalization plugins require the term normalize or normalization in order to display as a normalization output format choice when you configure DITA-OT Output Formats. Before uploading a custom normalization plugin, ensure its plugin.xml conforms to this naming convention.

      For example:

      <plugin id="org.dita.normalize">
  <transtype name="normalize" desc="Custom DITA normalization plugin"/>
   <feature extension="dita.conductor.target.relative" file="conductor.xml"/>
</plugin>
    3. Select Upload.

      The CMS installs the plugin.

Task Troubleshooting:

  • The System Plugins list displays only plugins with CMS-compatible transtype definitions. System administrators can verify prerequisite plugins without transtypes are installed by entering dita plugins in the command line within the DITA-OT bin folder.

  • For custom DITA-OT engine or plugin installation errors, review Prerequisites to ensure your customizations meet development requirements.
  • To uninstall the DITA-OT version, click the button displaying installed DITA-OT version (e.g., Version 3.6.1.igx), then click Uninstall DITA-OT.

Next Steps: Configure DITA output formats for Ingeniux CMS to use during post-publishing DITA transformation output generation.