Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Publishing DITA in Ingeniux CMS DITA-OT Output Files

DITA-OT Output Files

Prerequisites: You must have system administrator permissions to access the CMS server or permissions to access the replication target (if configured) to view DITA-OT files, output files, and temporary files.

DITA-OT Installation

The CMS deploys the DITA-OT package to [Drive:]\[path-to-cms-site-instance]\App_Data\ditaot\ when administrators install the DITA-OT, and the CMS installs plugin packages to the plugins folder when they add additional plugins.

DITA-OT folder structure
[Drive:]\
    └──[path-to-cms-site-instance]\
        └── App_Data\
            └── ditaot\
1)              └── [installed-dita-ot-name]\ <!-- [dita-ot-dir] -->
                    ├── bin\
                    ├── config\
                    ├── lib\
2)                  ├── plugins\
2.a)                │   └── [plugin-name]\
2.b)                │       └── plugin.xml
                    ├── resources\
                    ├── build.xml\
                    ├── catalog-dita.xml\
                    ├── integrator.xml
                    ├── LICENSE
                    ├── Notices.txt
                    ├── startcmd.bat
                    └── startcmd.sh

Notable DITA-OT folders and files for CMS system administrators include:

1) DITA-OT installation folder
The main DITA-OT installation directory where the DITA-OT package deploys to the CMS file system.
2) Plugins folder

The folder containing plugins that modify or expand DITA-OT publishing capabilities. Add custom styles, new output formats, or support for custom DTDs.. Install new plugins in Administration > DITA > Setup to deploy them to this location.

2.a.) Plugin subdirectory
Each plugin resides in its own subdirectory within the plugins folder.
2.b.) plugin.xml
Every plugin directory requires a configuration file named plugin.xml at its root that defines the plugin's capabilities and dependencies. This plugin descriptor file controls all aspects of the plugin, making each extension visible to the rest of the DITA-OT. The file uses pre-defined extension points to locate changes, and then integrates those changes into the core DITA-OT code.
Note
To use a plugin as a transformation output format for DITA pipeline publishing in the CMS, plugin.xml requires a a<transtype>.

Multi-Channel Output Folders and Files

The CMS writes generated output to subfolders within the pub folder. You can locate the pub folder contents on the CMS server within the installation site's folder structure and within your replication target.

Published DITA output folder structures differ between CMS 10.6.492 and CMS 10.6.308–10.6.378.

CMS 10.6.492

CMS 10.6.492 published DITA output folder structure
[Drive:]\
    └──[path-to-cms-site-instance]\
        └── App_Data\
            └── pub\
                └── [publishing-target-folder-name]\
1)                  ├── _DITA_Normalized_\
1.a)                │   ├── [DITA-root-folder-name]\
                    │   │   └── [path-to-normalized-output]\
1.b)                │   └── DITAVal-[ditaval-file-name]\
                    │       └── [path-to-normalized-conditional-output]\
2)                  ├── [DITA-root-folder-name]
                    │   └── [path-to-dita-]\
3)                  └── dita_out\
3.a)                    └── [output-format-transtype-name]\
3.b)                        ├── [DITA-root-folder-name]\
                            │   └── [path-to-static-output]\
3.c)                        └── DITAVal-[ditaval-file-name]\
                                └── [path-to-conditional-static-output]\
1) Normalized output folder
This folder stores published normalized DITA outputs. When normalizing content, DITA-OT post-publish processing operations resolve map references, keys, content references, code references, and other elements.
1.a.) Main normalized output folder
This folder stores all normalized DITA content except conditional normalized outputs where optional DITAVAL files apply. When a DITAVAL is referenced directly in the DITA map via <ditavalref>, the DITA publishing pipeline generates the corresponding conditional content in this path.
1.b.) Conditional normalized output folder
This folder stores normalized conditional output when users apply DITAVALs to the DITA collection that are not directly referenced via <ditavalref>. The pipeline generates a folder based on the name of each DITAVALapplied to the map at publish time.
Note
  • When multiple DITAVALs are applied at publish time, the system generates separate outputs based on each DITAVAL file. DITAVALs are not applied to the same output unless a DITAVAL is referenced directly in the map and an optional DITAVAL is additionally assigned to the map.
  • When a DITAVAL is referenced directly in the DITA map, the DITA publishing pipeline applies both the directly referenced DITAVAL and the optional DITAVAL filtering rules to the same output. The DITA publishing pipeline generates the output in the corresponding DITAVAL folder. If you want to prevent the directly referenced DITAVAL from being applied to the output, comment out the <ditavalref> from the map.
2) Non-normalized DITA output folder
This folder stores DITA assets published by the CMS without DITA publishing pipeline processing. These files are not normalized.
Note
When the DSS cannot locate normalized output in the normalized output path, the URL redirects to render the corresponding non-normalized DITA content from this path.
3) Static output folder
This folder stores published static output formats generated by the DITA publishing pipeline, such as Markdown, PDF, HTML5, and other formats.
3.a.) Static transformation type output folder
The pipeline generates a folder for each output format type, with the folder name matching the format name (e.g., pdf, html5).
3.b.) Main static output folder
This folder stores all DITA content published to the chosen output format type, except conditional normalized outputs where optional DITAVAL files apply. When a DITAVAL is referenced directly in the DITA map via <ditavalref>, the pipeline generates conditional content in the chosen static output format within this folder.
3.c.) Conditional static output folder
This folder stores conditional static content when users apply DITAVALs to the DITA collection that are not directly referenced in the map. The pipeline generates a folder based on the name of each DITAVAL applied to the map at publish time.
Note
  • When multiple DITAVALs are applied at publish time, the system generates separate static outputs based on each DITAVAL file. DITAVALs are not applied to the same output unless a DITAVAL is referenced directly in the map and an optional DITAVAL is additionally assigned to the map.
  • When a DITAVAL is referenced directly in the DITA map, the DITA publishing pipeline applies both the directly referenced DITAVAL and the optional DITAVAL filtering rules to the same static output. The DITA publishing pipeline generates the output in the corresponding DITAVAL folder. If you want to prevent the directly referenced DITAVAL from being applied to the output, comment out the <ditavalref> from the map.

CMS 10.6.308–10.6.378

CMS 10.6.308–10.6.378 published DITA output folder structure
[Drive:]\
    └──[path-to-cms-site-instance]\
        └── App_Data\
            └── pub\
                └── [publishing-target-folder-name]\
1)                  ├── [DITA-root-folder-name]
                    │   └── [path-to-normalized-output]\
2)                  ├── dita_out\
                    │   └── [output-format-transtype-name]\
                    │       ├── [DITA-root-folder-name]
                    │           └── [path-to-static-output]\
                    │       └── DITAVal-[ditaval-file-name]\
                    │           └── [path-to-conditional-static-output]\
3)                  └── DITAVal-[ditaval-file-name]\
                        └── [path-to-normalized-conditional-output]\

The pub folder contains three types of output:

1) Normalized output
This folder stores published normalized DITA outputs. When normalizing content, DITA-OT post-publish processing operations resolve map references, keys, content references, code references, and other elements.
Note
This folder contains all published DITA content, including content that did not undergo DITA publishing pipeline processing. To determine if a published DITA asset is normalized, check whether the first line of the DITA asset contains <?path2rootmap-uri ../?>. When present, the DITA content underwent DITA publishing pipeline normalization processing. When absent, the content was published without normalization.
2) Static output
This folder stores published static output formats generated by the DITA publishing pipeline, such as Markdown, PDF, HTML5, and other formats.
2.a.) Static transformation type output folder
The pipeline generates a folder for each output format type, with the folder name matching the format name (e.g., pdf, html5).
2.b.) Main static output folder
This folder stores all DITA content published to the chosen output format type, except conditional normalized outputs where optional DITAVAL files apply. When a DITAVAL is referenced directly in the DITA map via <ditavalref>, the pipeline generates conditional content in the chosen static output format within this folder.
2.c.) Conditional static output folder
This folder stores conditional static content when users apply DITAVALs to the DITA collection that are not directly referenced in the map. The pipeline generates a folder based on the name of each DITAVAL applied to the map at publish time.
Note
  • When multiple DITAVALs are applied at publish time, the system generates separate static outputs based on each DITAVAL file. DITAVALs are not applied to the same output unless a DITAVAL is referenced directly in the map and an optional DITAVAL is additionally assigned to the map.
  • When a DITAVAL is referenced directly in the DITA map, the DITA publishing pipeline applies both the directly referenced DITAVAL and the optional DITAVAL filtering rules to the same static output. The DITA publishing pipeline generates the output in the corresponding DITAVAL folder. If you want to prevent the directly referenced DITAVAL from being applied to the output, comment out the <ditavalref> from the map.
3) Conditional normalized output folder
This folder stores normalized conditional output when users apply DITAVALs to the DITA collection that are not directly referenced via <ditavalref>. The pipeline generates a folder based on the name of each DITAVALapplied to the map at publish time.
Note
  • When multiple DITAVALs are applied at publish time, the system generates separate outputs based on each DITAVAL file. DITAVALs are not applied to the same output unless a DITAVAL is referenced directly in the map and an optional DITAVAL is additionally assigned to the map.
  • When a DITAVAL is referenced directly in the DITA map, the DITA publishing pipeline applies both the directly referenced DITAVAL and the optional DITAVAL filtering rules to the same output. The DITA publishing pipeline generates the output in the corresponding DITAVAL folder. If you want to prevent the directly referenced DITAVAL from being applied to the output, comment out the <ditavalref> from the map.

Temporary Files

The CMS DITA publishing and preview pipeline generates temporary files that store data briefly while processing tasks run. These files act as a temporary workspace, helping manage large data sets, freeing memory, and protecting against data loss. The pipeline automatically deletes these files when processing completes, but they remain intact when fatal errors occur during pipeline processing or when users enable debug mode, which prevents temporary folder file deletion after processing completes.

Temp folder structures
[Drive:]\
    └──[path-to-cms-site-instance]\
        └── App_Data\
            ├── ditaot\
1)          ├── DitaPreviewTemp\
            │   └── [temporary-folder-name]\ <!-- e.g., Temp_00_efeae53338014b74bfcd9b86563ea4e6 -->
            │       └── [path-to-normalized-output-for-preview]\
2)          └── DitaTemp
                ├── _PreviewTask_[unique-identifier]\
                │   └── [timestamped-folder-name]\ <!-- e.g., Temp_00_efeae53338014b74bfcd9b86563ea4e6 -->
                │       ├── [dita-ot-temp-folder-name]\
                │       │   └── [path-to-fully-expanded-intermediate-dita-files]\
                │       └── [dita-ot-log-name].log
                └── _PublishingTasks_[unique-identifier]\
                    └── [timestamped-folder-name]\
                        ├── [dita-ot-temp-folder-name]\
                        │   └── [path-to-fully-expanded-intermediate-dita-files]\
                        └── [dita-ot-log-name].log
1. DITAPreviewTemp folder

The DITAPreviewTemp folder contains normalized preview files that emulate how the previewed DITA collection will display when published to the DSS. The CMS automatically retains these files.

2. DITATemp folder

The DitaTemp folder contains DITA-OT temporary build folders/files and temporary preview folders/files. The CMS retains temporary files when debug mode is enabled. When a DITA publish encounters errors, the CMS also retains DitaTemp automatically for troubleshooting purposes.

Settings Files

The CMS generates configuration and mapping files within the settings folder of each publishing target. These files support DITA content navigation, dependency tracking, and rendering functionality for both the DSS and DITA Preview. The CMS automatically creates and maintains these files during the publishing process to ensure proper content delivery and presentation.

Settings folder structure
[Drive:]\
    └──[path-to-cms-site-instance]\
        └── App_Data\
            └── pub\
                └── [publishing-target-folder-name]\
                    └── settings\
1)                      ├── AssetMap.xml
2)                      ├── DependencyMaps.json
3)                      ├── dita_normalization_wrapper.xml
4)                      └── UrlMap.xml
1. AssetMap.xml

The AssetMap.xml file constructs and tracks paths to all published asset entries, including DITA asset paths for navigation purposes.

2. DependencyMaps.json

The DependencyMaps.json file contains a manifest of all published DITA maps and their dependencies. The CMS uses this file internally. This file is machine-readable but not human-readable.

3. dita_normalization_wrapper.xml

The dita_normalization_wrapper.xml file contains the DITA rendering schema for DSS presentation. The DSS and DITA Preview use this schema content to contain normalized and transformed DITA content that displays as a page. Administrators set this schema in the Rendering Schema for DSS field in Administration > DITA.

4. UrlMap.xml

The CMS constructs and tracks site page URLs using UrlMap.xml as part of the published content set in the replication target directory. Treating DITA alias URLs similarly to site page URLs, the CMS also uses UrlMap.xml to construct and track alias URLs.

UrlMap.xml contains site content item paths and DITA aliases for navigation purposes. The system generates URLs for DITA aliases only when the Enable alias URL pathing checkbox is selected on the publishing target. See DITA Normalized Output URLs for details about UrlMap.xml DITA alias URL generation.