Related links elements

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-topic resources. Links are located 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 and 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.

3.1.1.4.1 link
The <link> element defines a relationship to another topic. Links are typically sorted when displayed based on their attributes, which define the type or role of the link's target in relation to the current topic.
3.1.1.4.2 linklist
The <linklist> element defines an author-arranged group of links. When you use a <linklist> element, the organization of links on final output is in the same order as originally authored inside that element.
3.1.1.4.3 linkpool
The <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.
3.1.1.4.4 linktext
The <linktext> element provides the literal label or line of text for a link. In most cases, the text of a link can be resolved during processing by cross reference with the target resource. 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, it is used as the text for the specified link; when used within a map, it is used as the text for generated links that point to the specified topic.
3.1.1.4.5 linkinfo
The <linkinfo> element allows you to place a descriptive paragraph after the links that are contained in a <linklist> element.

Parent topic: 3.1.1 Topic elements

Previous topic: 3.1.1.3.11 stentry

Next topic: 3.1.1.4.1 link

3.1.1.4 Related links elements