DITA Publishing Pipeline Troubleshoot Checklist
DITA users can encounter a spectrum of issues when running DITA-OT transformation processes. These issues can vary depending on factors involved.
Before troubleshooting DITA Publishing Pipeline issues, review the following factors that influence the type of issues administrators and users may experience. By identifying factors involved, users can use this information to help pinpoint issues while troubleshooting.
The questions below serve as prompts to help you identify potential factors that may play a role in your issue.
This topic includes:
DITA Publishing Pipeline Setup
We recommend that system administrators review these factors.
Ensure your DITA Administration settings are configured to suit your needs. See DITA Administration for details.
- Which DITA-OT version is installed?
- For rendering DITA views, which page schema is applied?
- Which transformation output formats are applied?
- Which DITA-OT parameters are applied?
- Which publishing targets use DITA post-publish content processors? Are these processors enabled or disabled?
- Which transformation output formats are applied?
- For rendering DITA views, does the DITA content processor include a normalized DITA output with a URL partial match string?
- If using JSON post-publish processing, what are the configurations for the JSON processor that works in conjunction with the DITA content processor?
Settings Applied at DITA Preview Time
We recommend that DITA users review these factors.
Ensure the DITA preview ran with settings applied to suit your needs. See DITA Preview and XML for details.
- Which DITA maps were included in the preview scope? Did the publish include the top level map or lower level maps?
- For conditional processing, which DITAVAL was applied at preview time?
Settings Applied at DITA Publish Time
We recommend that DITA users review these factors.
Ensure the DITA publish ran with settings applied to suit your needs. See Publishing DITA Assets for details.
Which publish type did the system execute? A full or incremental publish?
- Which DITA maps were included in the publish? Did the publish include the top level map or lower level maps?
- Which transformation output formats were applied at publish time?
- For conditional processing, which DITAVALs were applied at publish? Did the transformation process omit outputs that exclude conditional processing?
Next Steps
After reviewing the checklist items, return to the appropriate troubleshooting topic to continue diagnosing your issue.
Preview
- To continue diagnosing the cause of DITA preview log errors, return to DITA Preview Log Entries Flag Errors.
- To continue diagnosing unexpected DITA preview output results, return to Unexpected DITA Preview Results.
- To continue diagnosing DITA preview output generation failures, return to No DITA Preview Output.
Publishing
- To continue diagnosing the cause of DITA publish log errors, return to DITA Publish Log Entries Flag Errors.
- To continue diagnosing unexpected DITA publish output results, return to Unexpected DITA Publishing Output Results.
- To continue diagnosing DITA publish output generation failures, return to No Output After DITA-OT Publish.