Turning on Debug Mode


DITA users with permissions to publish DITA sets can turn on debug mode for DITA-OT post-publish processing. This mode allows more information to be written to the publishing logs, including verbose logging, details on Java classes, additional Ant properties and overrides, preprocessing filters, parameters, and stages, and the complete build sequence.

When previewing or publishing DITA for the first time, we recommend enabling debug mode in case you need to troubleshoot either of these operations.

Tip
If users want to display additional verbose logging along with debug information, they can request administrators to enable the verbose parameter in Administration > DITA > DITA-OT Parameters.

To enable debug mode:

  1. After logging into Ingeniux CMS, click your login name or profile photo in the upper right corner of the CMS application.
    The Edit your Profile dialog displays.
  2. Select the Advanced tab in the dialog.
  3. Select the Invoke DITA in debug mode checkbox.

  4. Click Save.

Next Steps:

After you run a DITA preview or publish with debug mode turned on, complete the following steps to access the debugging information:

  1. After your preview or publish operation completes, navigate to Administration > Publishing Monitor > Show DITA Logs button.

    The Post Processing Status Console displays.

  2. In this dialog, you can download log files containing additional debug information. For those DITA maps that contain errors, you can download the DITA-OT temp folder for the associated DITA map, which may help you troubleshoot the issue.
Note
If you clear the Invoke DITA-OT in debug mode checkbox, then the temp log download column will not display in the Post Processing Status Console dialog during post-publish processing.