DITA Aliases


Aliases are Site Tree objects that represent DITA assets, enabling you to integrate DITA content with CMS pages and components. Use aliases to do the following:

  • Add DITA content, document structure, and navigation hierarchy to the Site Tree.
  • Generate friendly URLs for DITA content.
  • Link to aliases IDs from pages and components.

Overview

Ingeniux CMS manages DITA content as assets in the Asset Tree and pages and components in the Site Tree. Create aliases for DITA maps or individual topics under any Site Tree page, component, or folder. When you select a map, the CMS generates aliases for each dependency based on the map's structure and hierarchical relationships from the latest checked-in version or any version marked for publishing.

Aliases represent DITA content and automatically update to reflect changes when you check in marked versions of the DITA assets, ensuring the aliases always match the correct version. The actual DITA content remains in the Asset Tree for editing and management. After creation, click aliases in the Site Tree to open to the correlating DITA assets in the main pane.

For site implementations that maintain a mixed format authoring environment and require DITA content to assimilate with page content, aliases can help you to both manage and publish these collections. Your organization may need to integrate DITA with CMS pages (HTML), displaying DITA content alongside page content on your website. Envisioning your overall website organization for these types of "mixed" integration scenarios can be challenging. The alias feature helps organizations model complex format integrations in the Site Tree prior to publishing content.

Published aliases function like content items for the purpose of site navigations, creating integrated navigation entries for DITA assets within DSS page rendering scenarios.

Alias Manager

Ingeniux CMS provides the following interfaces to manage aliases:

  • For administrators, navigate to Administration > DITA > DITA Map Manager > [DITA Map] > Manage Aliases).

  • For users, navigate to Assets > [DITA Map or Topic] > Alias Management.

  • You can view the full alias structures in the Site Tree.

Manage aliases through Administration.

This section includes:

CMS 10.6.378+ Dependency Versioning

DITA dependency behavior differs between CMS 10.6.378+ and CMS 10.6.308–10.6.342.

The CMS 10.6.308-10.6.342 alias management system only tracks DITA dependencies from the latest checked-in version of the aliased DITA map. If marking an older map version for publish, the alias management system does not account for dependency and content changes in the marked version. If you publish the older map version, aliases only account for the latest version content and dependencies.

CMS 10.6.378+ introduces dependency versions, where the alias management system accounts for content and dependency changes in the latest version and any historical version of the DITA content marked to a publishing target.

For example, if a dependency resides in the latest map version (the most recent version listed in the map's History tab) but not in an older version marked for publishing, that dependency will not be included in alias structure for that publishing target.

Use this feature to suppress unpublished dependencies, customize alias structures for different targets, and more. Filter alias structure dependencies by using selecting the appropriate publishing target from the Site Tree drop-down list.

See CMS DITA Versioning Functionality for details about other CMS dependency versioning features.

Version Notes: CMS 10.6.492
CMS 10.6.492 adds a drop-down in the alias manager tabs to filter aliases by version (latest checked-in version or version marked for publishing). Aliases display in the Site Tree only for their designated publishing targets.

If the Site Tree does not display aliases, verify the aliases are marked to the target selected for the Site Tree publishing target filter and the DITA asset's Manage Aliases tab lists the alias for that target.

DITA Alias IDs

The CMS generates unique IDs (da/ID) for each DITA alias. You can use these IDs to link to DITA content from pages and components, and publishing processes use the IDs to build URL map entries when alias URL pathing is enabled.

View an alias ID by hovering over alias in the Site Tree, and search for DITA assets by alias ID using CMS search with the Pages filter is selected.

Alias Naming

Aliases inherit their names from the corresponding DITA asset's <title> element. If you change the title and check in the asset to the marked publishing target, the alias name updates automatically.

Note
DITA elements and attributes may affect the alias name. See Aliased DITA Elements DITA Alias Attributes for details.

CMS 10.6.378+ Localization

DITA alias localization behavior differs between CMS 10.6.378+ and CMS 10.6.308–10.6.342.

In CMS 10.6.308–10.6.342, you can only set one wrapper page type based on the default DSS rendering schema for DITA content, meaning the content wrapper only returns components and other data for the default locale. For localized DITA aliases, the wrapper does not return lingually cloned content versions based on locale.

CMS 10.6.378+ supports setting a wrapper page type based on any locale-specific DSS rendering schema, and aliases accurately reflect the locale of their corresponding DITA content. DITA publishing pipeline and preview processes render localized DITA aliases to the DSS with the appropriate expanded XML locale data.

See Rendering Localized DITA Content for more details.

Alias URLs

When publishing targets alias have URL pathing enabled, the CMS builds friendly alias URLs based on their Site Tree location rather than the DITA asset location in the Asset Tree. For example, if you create an alias under the Knowledge Base/Documents pages, the generated alias URL is knowledge-base/documents/[name-of-alias]/.

Published aliases can become part site content and be included in navigations and links. When users click alias links on the DSS, they access the DITA content through the Site Tree structure, even though the source assets remain in the Asset Tree behind the scenes. The DSS displays the normalized output as styled XML.

Version Notes: CMS 10.6.492
  • After publish, CMS 10.6.492 lists the alias URL in the DITA asset's Properties > URL Management tab for corresponding publishing targets.

  • Administrators configure DITA map inclusion in alias URLs through publishing target settings.
    • If enabled, map assets receive their own alias URLs, and topic URL paths include map names.
    • If disabled, maps do no receive alias URLs, and topic URL paths exclude map names.