Search results

DITA: Inline links

To link to another topic or external site inline, you use the xref element.

As a general best practice, people say to avoid inline links if possible, but if referring to another topic or page, it might seem odd not to include the link.

The topic title will automatically be used as the anchor text for the link.

   <xref href="sample.dita"/>

If you want to manually specify the anchor text, code it like this:

   <xref href="sample.dita">Sample</xref>

If you're linking to an external source, you need to add the scope and format attributes to your link:

   <xref href="" scope="external" outputclass="external" format="html"></xref>

About Tom Johnson

Tom Johnson

I'm a technical writer / API doc specialist based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out my API documentation if you're looking for more info about that. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.