<linktext>

Link text is the label for a link or resource.

The <linktext> element provides descriptive text for a link. It is most commonly used when the target cannot be resolved during processing or when a title for the reference cannot be determined by a processor. For example, link text might be required when the link is to a peer, external, or non-DITA resource.

When a link contains a <linktext> element, the content of the <linktext> element is rendered instead of the text that retrieved from the resource.

The following attributes are available on this element: universal attributes.

Example

The following code sample shows how a <linktext> element can be used to provide link text for a related link to a non-DITA resource:

<related-links>
  <link href="SQLJ-example.html" format="html" scope="local">
    <linktext>Accessing relational data with SQLJ</linktext>
  </link>
</related-links>