Adobe FrameMaker User Guide
Click here to see this page in full context

Home > Appendix > DITA 1.3 specification > Language reference: All-inclusive edition > Topic elements > Basic topic elements > related-links

<related-links>

The related information links of a topic (<related-links> element) are stored in a special section following the body of the topic. After a topic is processed into its final output form, the related links are usually 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 are typically displayed together with links generated based on a map context.

The following lists contains processing expectations for related link element:

  1. Links within a <linklist> element appear in the order defined, while those outside of a <linklist> might be sorted and displayed in a different order or location (based upon their role, target, importance, or other qualifiers).
  2. PDF or print-oriented output typically ignores hierarchical links such as those with roles of ancestor, parent, child, descendant, next, previous, or sibling, although this behavior is not required.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- topic/related-links

Example

The following indicates that the two external links are always applicable to this topic, regardless of how the topic is used.

<related-links scope="external" format="html">
  <link href="http://www.example.org">
    <linktext>Example 1</linktext>
  </link>
  <link href="http://www.example.com">
    <linktext>Example 2</linktext>
  </link>
</related-links>

Attributes

The following attributes are available on this element: Universal attribute group, Link relationship attribute group (apart from @href), The role and otherrole attributes, and outputclass.

Parent topic: Basic topic elements

September 29, 2022

Legal Notices | Online Privacy Policy