Back to Search Back to Search Results

Map Transform Conventions

The built-in modules transform DITA maps into a nested list structure.

Maps are represented as <div> constructed normally. The table of contents represented by a map is represented by a root <ul id="toc"> element. Each visible topicref is represented by an <li class="tocentry topicref [...]"> element. The contents of the element are

  1. A sequence/number identifier based on the location in the map.
  2. The title of the topicref, derived from the <navtitle> of the topicref or the title of the referenced topic, per DITA rules.
  3. If a topic is referenced, the label will be wrapped in the appropriate <a> tag. By default, only the @href attribute is included, though this can be customized by overriding the named topicref-toc-atts template.
  4. If a topic is not referenced, the label will be wrapped in <span class="topichead">, and additional attributes can be set by implementing the named topicref-topichead-atts template.
  5. A nested <ul class="toclevel"> element ocntaining child topicrefs, if any.

Only visible topicrefs will be processed. A visible topicref

  • Does not have processing-role="resource-only"
  • Does not have toc="no"
  • Has a navtitle, or references a topic with a non-blank title.

All other <topicref> elements are ignored.