Guidelines

Keep these guidelines in mind when using the related-links element:

• If you link to topics in Heretto, links added in the related-links element resolve to topic titles.
• If you publish to a print-friendly output (for example, PDF), ensure that the topic that you link to is included in the same map as the topic that you link from.
• If you link to external resources, for example websites, you must add a link text manually. Remember to make it generic to avoid maintenance issues.
• The related links are usually displayed at the end of the topic. Some web-like outputs (for example, webhelps) may display them in a separate navigation pane.

Structure

• topic body
  • topic elements
  • related-links element
    • link element (any number)
      • linktext element
      • desc element
    • linklist element (any number)
      • title element
      • desc element
      • linklist element (any number)
      • link element (any number)
        • linktext element
        • desc element
    • linkpool element (any number)
      • title element
      • desc element
      • linkpool element (any number)
      • link element (any number)
        • linktext element
        • desc element

Elements

related-links element

A container for links to the resources related to the topic.

link element

A link to a:

• DITA or non-DITA file in your Content Library
• A website or file hosted on an external server

linktext element

Enables you to provide a custom link text.

desc element

Describes an element.

linklist element

A container that enables you to arrange a group of link elements.

linkpool element

A container that contains a group of link elements with common characteristics like audience or source.

title element

The title of a given element.

Examples