Name

link — A hypertext link

Synopsis

link ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • endterm (IDREF)

  • xrefstyle

Description

The link is a general-purpose hypertext element. Usually, link surrounds the text that should be made “hot” (unlike xref which must generate the text), but the endterm attribute can be used to copy text from another element.

The link can have either a linkend attribute or an xlink:href attribute. If it has an xlink:href attribute, link is the equivalent of an HTML anchor (<html:a href="...">) for cross-reference with a Uniform Resource Identifier (URI).

Processing expectations with linkend

Formatted inline.

If the link element has content, then that content is processed for output as the “hot” text. If the link element has content and an endterm attribute, then the content is used and the endterm is ignored. If the link element has an endterm attribute and no content, then the content of the element pointed to by endterm should be repeated at the location of the link and used as the “hot” text.

Processing expectations with xlink:href

Formatted inline.

When rendered online, it is natural to make ...

Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.