<related-links>

Related links are a group of references to other topics or external information related to the current topic.

Rendering expectations

Related links usually are displayed at the end of the topic, although some web-based help systems might display them in a separate navigation frame.

Links specified within the <related-links> element typically are displayed together with any links that are generated based on the hierarchy of the DITA map.

PDF or print-oriented output commonly ignores hierarchical links such as those with roles of ancestor, parent, child, descendant, next, previous, or sibling.

Processing expectations

Attributes that cascade between topic references in a map, such as the @scope and @format attributes, also cascade from this element to contained links.

Attributes

The following attributes are available on this element: universal attributes, @format, @otherrole, @role, @scope, and @type.

Example

The following code sample shows how the <related-link> element is used to specify stable links to external and local information:

<related-links>
  <link href="http://www.example.org" scope="external" format="html">
    <linktext>Example #1</linktext>
  </link>
  <link href="additional-details.dita">
    <!-- Link to a local topic for more detail. The link text is generated
         based on the title of the topic. -->
  </link>
</related-links>