Aliased DITA Elements
Review how the CMS generates aliases for different DITA map elements in your content structure. When planning your DITA maps, analyze:
- Which elements will generate aliases in the Site Tree.
- How alias names are determined for each element type.
- What document type information displays for aliased elements.
- Whether elements are included in alias URL pathing and site navigation.
See OASIS DITA Version 1.3 Specification for details about DITA elements.
- To use alias URL pathing, select the Enable alias URL pathing checkbox on the publishing target.
- DITA asset types and attributes in your DITA assets may affect alias generation.
Basic Map Elements
<map>
The CMS generates alias structures based on the map's hierarchical structure, including all referenced topics and submaps.
In the Site Tree, document type information tags indicate the DITA Map type. The alias name uses the map's <title> value.
When published and replicated, the aliased map structure renders on the DSS with navigation links when alias URL pathing is enabled.
10.6.492: Choose whether to include maps in alias URLs by configuring the Include Alias Containers in URLs checkbox on the publishing target. When enabled, maps receive their own accessible alias URLs.
CMS 10.6.308–10.6.378: Maps are excluded from alias URL entries.
<topicref>
The CMS generates an alias for each referenced topic within the map structure.
In the Site Tree, document type information tags indicate the topic type (for example, concept, task, reference) based on the topic's DTD. The alias name uses the topic's <title> value.
When published and replicated, the aliased topic renders on the DSS and is included in the navigation.
<topicref> contains @locktitle="yes" and a @navtitle value, the alias name uses the @navtitle. Otherwise, the alias name uses the topic's <title> value. Map Group Elements
<keydef>
Key definition elements define reusable keys for content.
CMS 10.6.492: Aliases are not generated
for <keydef> element references.
CMS 10.6.308–10.6.378: The CMS generates aliases for DITA assets
referenced by <keydef> elements and included
them in alias URL generation.
To prevent alias creation for <keydef>, add @processing-role="resource-only"
to the element or its parent element .
<mapref>
The CMS generates alias structures for submaps (maps referenced within maps).
In the Site Tree, document type information tags indicate the type (DITA Map or Book Map) based on the map's DTD.
When published and replicated, the aliased map structure is included in navigation.
CMS 10.6.492: Choose whether to include maps in alias URLs by configuring the Include Alias Containers in URLs checkbox on the publishing target. When enabled, maps receive their own accessible alias URLs.
CMS 10.6.308–10.6.378: Maps are excluded from alias URL entries.
<topicgroup>
Topic group elements organize related topics without creating a hierarchy.
CMS 10.6.378+: Aliases are not generated for <topicgroup> elements. Aliases are generated only for the child elements of <topicgroup>.
CMS 10.6.308–10.6.342: Aliases are generated for both <topicgroup> and their child elements. The container icon 
displays next to <topicgroup> aliases instead of the DITA content icon.
Aliases of <topicgroup> elements correspond with the referencing map. The aliases serve as a visual heading-only representation to indicate where these group elements reside within the map structure.
<topichead>
Topic head elements create navigation headings without referencing specific content.
CMS 10.6.492: Aliases are generated for
<topichead> elements with both @id and @navtitle values. Regardless
of whether an alias is generated for <topichead>,
aliases are always generated for its child elements.
In the Site Tree, document type information tags indicate DITA Map Container. When you click the alias, the CMS navigates to the DITA asset referenced by the parent element of the <topichead> element.
When published and replicated, the <topichead> alias URL redirects to the DITA asset referenced by the parent element.
CMS 10.6.378: Aliases are not generated for <topichead> elements. Aliases are only generated for its child elements.
CMS 10.6.308–10.6.342: Aliases are generated for both <topichead> elements and their child elements. The container icon displays next to <topichead> aliases instead of the DITA content icon. The <topichead> alias name uses the corresponding <navtitle>.
Aliases of <topichead> elements correspond with the referencing map. The aliases serve as a visual heading-only representation to indicate where these elements reside within the map structure and how they influence the map hierarchy.
When published and replicated, the aliased <topichead> displays as a non-clickable entry in navigation.
<topicset>
Topic set elements group related topics that share common characteristics or processing requirements.
CMS 10.6.378+: Aliases are not generated for <topicset> elements. Aliases are only generated for its child elements.
CMS 10.6.308–10.6.342: Aliases are generated for both <topicset> elements and their child elements. The container icon displays next to <topicset> aliases instead of the DITA content icon. The corresponding <navtitle> displays as the <topicset> alias name.
Aliases of <topicset> elements correspond with the referencing map. The aliases serve as a visual heading-only representation to indicate where these elements reside within the DITA map structure.
When published and replicated, the aliased <topicset> displays as a non-clickable entry in the navigation.
Bookmap Elements
<bookmap>
The CMS generates alias structures based on the bookmap's hierarchical structure, including all referenced topics and submaps.
In the Site Tree, document type information tags indicate Book Map. The alias name uses the map's <title> or <mainbooktitle> value.
When published and replicated, the aliased map structure renders on the DSS with navigation links when alias URL pathing is enabled.
CMS 10.6.492: Choose whether to include DITA maps in alias URL entry generation by configuring the Include Alias Containers in URLs checkbox on the publishing target. When enabled, maps receive their own accessible alias URLs.
CMS 10.6.308–10.6.378: DITA maps are excluded from alias URL entries.
<mainbooktitle>
The alias name uses the <mainbooktitle> value corresponding with the bookmap. If a <mainbooktitle> or <title> value does not exist, the alias name uses the bookmap file name.
Bookmap content elements
All bookmap content elements follow the same alias generation pattern.
In the Site Tree, document type information tags indicate the DITA document type based on the referenced topic's DTD. The alias name uses the referenced asset's <title> value.
When published and replicated, the aliased DITA assets render on the DSS and are included in navigation.
@locktitle="yes" and @navtitle attribute values, the alias name uses the @navtitle. Otherwise, the alias name uses the referenced asset's <title> value. Elements that use this alias generation patten include:
<abbrevlist><amendments><appendix><bibliolist><bookabstract><booklist><chapter><colophon><dedication><draftintro><glossarylist><notices><part><preface><trademarklist>
Other Map Elements
<ditavalref>
DITAVAL reference elements link to filtering files that control conditional content processing.
CMS 10.6.492: Aliases are not generated for referenced DITAVALs.
CMS 10.6.308–10.6.378: The CMS generates an alias for referenced DITAVALs but excludes them from alias URL generation.
In the Site Tree, document type information tags indicate DITAVAL.
<glossref>
The CMS generates an alias for the referenced glossary entry topic and includes the topic within the map's alias structure.
In the Site Tree, document type information tags indicate Glossentry or Glossgroup. The alias name uses the referenced glossary entry's <glossterm> value.
When published and replicated, the aliased topic renders on the DSS, and the topic is included in the alias navigation.
CMS 10.6.492: The alias name uses the
referenced glossary entry's <glossterm>
value.
CMS 10.6.308–10.6.378: The alias name uses the referenced glossary entry's asset file name. To display the glossary entry name, add @locktitle="yes" and a @navtitle value that matches the <glossterm> value to <glossref>.
Topic Elements
<title>
The alias name uses the <title> value corresponding with the DITA asset. If a <title> value does not exist, the alias name uses the DITA asset file name.
@locktitle="yes" and a @navtitle value, the alias name uses the @navtitle. Otherwise, the alias name uses the topic's <title> value. <navtitle>
The alias name uses the @navtitle attribute instead of the <navtitle> element where applicable. See @navtitle for details.