<linktext>

Link text is the label for a link or resource.

Usage information

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.

Rendering expectations

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

Content model

(Text | <data> | <sort-as> | <foreign> | <keyword> | <term> | <text> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> )*

Attributes

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

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

Example

This section is non-normative.

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>