Map Links

Map links enable you to link topics in a map based on their parent-children relationship in the map structure.

Overview

You create map links by using the appropriate map structure and the collection-type attribute.

The collection-type attribute can take the following values:

sequence value
Generates an ordered list of links from parent to children. The order of links is the same as the order of topics in the map.
unordered value
Generates an unordered list of links from parent to children. The order of links is the same as the order of topics in the map.
family value
Generates an unordered list of links from parent to children and from sibling to sibling. The order of links is the same as the order of topics in the map.
choice value
Uncommon and typically used in custom outputs that enable the user to select one child topic to continue. In most cases, it is rendered in the same way as the unordered value.
Figure 1. Map Links Operation.
The following example shows that:
  • The “Task B” is a process topic with the collection-type attribute set to the sequence value.
  • “Task B” will link to “Task C”. “Task D”, and “Task E” in the output.
  • The linked topics will not link to each other outside the map.
Map linking

Use Cases

Consider using map links in the following situations:

  • When you want to create a process topic based on map links
    Figure 2. Process Map Structure.
    The following example shows that:
    • There are three procedures appended under the “Process A” topic.
    • The “Process A” topic has the collection type attribute assigned
    Process map structure
    Figure 3. Rendered Process Topic.

    The following PDF example shows a sample process of the structure visible in Process Map Structure.

    Rendered process topic
  • When you want to enhance navigation between certain sections in a web format like webhelp

Maintenance Considerations

Keep the following considerations in mind when working with map links:

  • Map links do not limit topic reuse because you link topics on a map level.
  • Map links are based on map structure. If you change the map structure, they links will be updated.

Publishing Considerations

Keep the following considerations in mind when publishing map links:

  • Map links resolve at publish and link text is populated with the topic titles.
  • If you publish to a print-friendly output (for example, PDF), links may reference a page number.
  • You must use the DITA Open Toolkit and set the args.rellinks parameter to all.