The related-links section of DITA topics is a special structure that contains links. Links support navigation from a topic to other related topics or resources.
Links are different from cross-references. While cross-references occur only within the body of a topic and can target any element in this or other topics, links only represent topic-to-topic connections, or connections to non-DITA resources. Links occur after the body of a topic, in the related-links element.
Links can also be managed indirectly using DITA maps, which provide a more efficient way to manage links. Using maps to define links avoids embedded pointers in each topic. This helps keep topics free from specific contexts, and makes it easier to reuse those topics in new locations.
<link>
element defines a relationship to another topic or non-DITA resource. When displayed, links are typically sorted based on their attributes, which define the type or role of the link's target in relation to the current topic.<linklist>
element defines an author-arranged group of links. When rendering the links, processors SHOULD preserve the order of links specified within a <linklist>
element.<linkpool>
element defines a group of links that have common characteristics, such as type or audience or source. When links are in <related-links>
or <linkpool>
elements, the organization of links on final output is determined by the output process, not by the order that the links actually occur in the DITA topic.<linktext>
element provides the literal label or line of text for a link. For links to local DITA topics, the text of a link can typically be resolved during processing. Use the <linktext>
element only when the target cannot be reached, such as when it is a peer or external link, or when the target is local but not in DITA format. When used inside a topic, <linktext>
is used as the text for the specified link; when used within a map, <linktext>
is used as the text for generated links that point to the specified topic.<linkinfo>
element allows you to place a descriptive paragraph after the links that are contained in a <linklist>
element.