Running the DITA-OT Locally Outside the CMS

  • System administrators must download their CMS DITA collection to their local machine. See DITA Map Manager for details to download DITA collections.
    For an accurate comparison of CMS DITA-OT processes and stand-alone DITA-OT processes, do not modify the downloaded DITA collection.
  • System administrators must install the DITA-OT version to their local machine. For standard DITA-OT versions, see Installing DITA Open Toolkit for details. Ensure the DITA-OT version matches the version used in the CMS.
  • For comparison purposes, system administrators must execute a DITA-OT publish on their DITA collection via the CMS. Note the DITA-OT version, parameters, and DITAVALs applied to the transformation process. When the publish completes, access the output files. See Checking DITA Publishing Output Directory for details.
    See the DITA Publishing Pipeline Troubleshoot Checklist for details about other factors to note.

Users may encounter issues or other discrepancies that stem from the DITA-OT version or other factors. To determine whether the issue stems from the DITA-OT version, users can run the DITA-OT outside of the CMS on their local machines. By running the DITA-OT outside the CMS, users can compare their local machine DITA-OT output against their CMS DITA-OT output results.

To run the DITA-OT version locally:
  1. Navigate to the bin folder within the DITA-OT installation directory, and open the Windows command line application.
  2. Execute the DITA-OT transformation process from the command line. See Building DITA-OT Output for details to run the dita command-line tool that executes the DITA-OT transformation process.
    If you use parameters for your transformation, see DITA-OT parameters for details to add parameters to your command.
  3. Copy the DITA-OT transformation log details from the command line application, and paste them in a text editor.
    Press CTRL+A to select all content within the log.
  4. Review the DITA-OT transformation log details in the text editor, and note any errors or discrepancies.
  5. Compare your local DITA-OT log and output files against the DITA-OT log and output files generated by the CMS DITA-OT, and note any discrepancies.

Next Steps: If your DITA-OT log displays errors, then your issue may relate to a conflict within your DITA content or a conflict with the DITA-OT version. If you use parameters, your issue may relate to a parameter conflict. See Interpreting DITA Log Errors for details to address these issues.

If errors occur in the CMS DITA-OT transformation process that do not occur in the DITA-OT transformation process outside the CMS, then double-check your CMS DITA Publishing Pipeline Setup. If you still run into issues, contact Ingeniux Support.