What is the syntax for creating links to metadata and references in DITA?

November 10, 2023
|By Bryan Tipper

Linking to metadata and references in DITA XML involves using specific elements and attributes to establish the connection between your content and the metadata or reference resources. This is vital for enhancing the informational value and credibility of your documentation. Here’s a breakdown of the syntax for creating links to metadata and references in DITA XML.

1. Linking to Metadata: To link to metadata, you can use the <foreign> element. This element allows you to embed metadata information within your content. You can specify the source of the metadata using the “href” attribute. It helps you provide additional context and reference external resources.

Example:

Suppose you want to link to metadata information in your DITA topic:


<topic>
  <title>Using Metadata in DITA</title>
  <body>
    <p>The information in this topic is based on <foreign href="metadata_source.xml">external metadata</foreign>.</p>
  </body>
</topic>

2. Linking to References: To link to references in DITA, you can use elements like <ph> and <cite>. The <ph> element is used to mark the text you want to link, while the <cite> element provides information about the reference source. This syntax enables you to maintain a structured citation style in your documentation.

Example:

If you want to create a reference link in your DITA topic:


<topic>
  <title>Creating Reference Links</title>
  <body>
    <p>For more details, refer to the <ph><cite href="reference_source.html">official documentation</cite></ph>.</p>
  </body>
</topic>

By using these syntax patterns, you can effectively create links to metadata and references in DITA XML, improving the depth and reliability of your documentation.