Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Initial DITA Configuration

Initial DITA Configuration

Prerequisites: CMS 10.6 must be installed. See CMS Statistics for details to check your version.

Prior to uploading existing DITA sets or creating new ones, CMS administrators must configure Ingeniux CMS to process DITA. A typical DITA configuration should take no more than a few minutes. Use the diagram below as a basic DITA configuration guide and to get a sense of where in the CMS DITA configuration takes place and in what order. You can click the links in the diagram to learn more about each configuration step.

DITA Publishing Set Up
DITA Publishing Set Up

The DITA publishing environment within the CMS requires the following steps at a minimum. Click any of the links below to learn more about these steps and about additional options you can set.

Important
The DITA publishing pipeline requires at least 32 GB of RAM. Keep in mind the following factors:

  • If your organization plans to store large DITA collections in the CMS, you may require more than 32 GB of RAM.

  • When processing large DITA maps, the DITA-OT alone may use up to 8 GB of RAM. However, RAM utilization is typically released by Java VM. If you do not meet the RAM requirement, the server will remain out of memory until the process completes.

  • Dependency building during publishing uses RAM, especially when content dependencies share extensive connections.

  • For published DITA content, the DSS will deserialize dependencies and cache them in RAM. This can take an additional 2 to 4 GB of RAM.

  1. Install Java: The DITA Open Toolkit requires the Java SDK to be installed on the server where Ingeniux CMS resides.

    See Oracle's Java SDK installation instructions for details. To complete the Java environment installation, you may need to restart the CMS server.

    Troubleshooting
    We recommend installing Oracle's Java SDK. An issue occurs with Microsoft's OpenJDK 17, where the cleanup of the temp folder fails during the DITA-OT transformation processes.

  2. Create DITA Root Folder: This will be the asset folder where all DITA content will reside in order for them to be published.

  3. Set DITA Root Folder: CMS administrators must set the asset ID of the DITA root folder in Administration > DITA > Setup.

  4. Install DITA-OT: CMS administrators must install a version of the DITA Open Toolkit in Administration > DITA > Setup.

  5. Select DSS Schema (Rendering DITA Schema for DSS): CMS administrators must set the appropriate schema for DITA in Administration > DITA > Output Formats.

  6. Select Outputs: CMS administrators must select the required output formats in Administration: > DITA > Output Formats.

  7. Configure Post-Publish Processing: CMS administrators must configure the appropriate processing application in Administration > Publishing System > Publishing Targets.

  8. Upload DITA Assets: Users must upload DITA assets to Ingeniux CMS (or create them in the CMS).

  9. Check In DITA Assets: Users must check in all DITA maps and their dependent content prior to publishing.

  10. Mark Map(s) for Publish: Users must mark all DITA maps and their dependent content for the intended publishing target(s).

  11. Publish Map(s): Users with administrative rights publish DITA maps in the desired output formats.

Rendering Configuration

After completing the basic DITA setup above, configure DITA rendering to display normalized content properly in DITA Preview and on the DSS. Rendering configuration involves setting up stylesheets, ASP.NET views, and DITA-OT parameters.

For comprehensive details about how DITA rendering works and how to set up and configure DITA rendering, see DITA Rendering Configuration.

Alias Configuration

DITA aliases allow you to create navigational entries in the Site Tree that correspond to DITA content in the Assets Manager. Aliases enable normalized DITA content to be included in site navigation and accessed via URLs, similar to regular site pages.

The alias feature is optional and can be a valuable tool depending on your DITA implementation needs. Consider whether using aliases will streamline your content management and improve your workflow before enabling this feature. If you’re unsure, review your current processes and consult with your team to determine if aliases add value to your CMS experience.

For comprehensive details about DITA aliases and how to use them, see DITA Aliases Overview.

For details to set up and configure DITA aliases, see DITA Alias Configuration.