<link>: How do you use the <link> element to create hyperlinks and cross-references to other DITA topics or external resources within a DITA topic?

November 10, 2023
|By Bryan Tipper

The <link> element in DITA XML is used to create hyperlinks and cross-references to other DITA topics or external resources within a DITA topic. It plays a crucial role in enhancing the navigational experience of readers by allowing them to easily access related information. The <link> element can be used to connect different parts of your documentation, providing context, references, and additional resources where needed.

Usage of <link> Element

To use the <link> element, you include it within the content of a DITA topic, specifying both the target and the text that appears as the link. You can link to other DITA topics within the same project or to external resources such as websites, PDFs, or documents. The target of the link can be a DITA topic ID, a URL, or a file path, depending on where the linked content is located.

Example:

Here’s an example of how to use the <link> element to create a hyperlink to another DITA topic within a DITA topic:


<topic id="example_topic">
  <title>Using Advanced Features</title>
  <body>
    <p>This topic covers the basics of using advanced features in the software. For more detailed information, you can refer to the <link href="advanced-configuration.dita">Advanced Configuration</link> topic.</p>
  </body>
</topic>

In this example, the <link> element is used to create a hyperlink to the “Advanced Configuration” DITA topic, allowing readers to navigate directly to that topic for additional details on the subject.