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 the content of the
link element an active link. When rendered in print
media, the URI might be ignored, printed after the
text of the link, or printed as a footnote.
When the content of the link element is
empty, the content of the xlink:href attribute should be rendered as
the text of the link.
Attributes
Common attributes and common linking attributes.
- endterm
Points to the element whose content is to be used as the text of the link
- xrefstyle
Specifies a keyword or keywords identifying additional style information
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example link</title>
<section>
<title>Examples of <tag>link</tag></title>
<para>
In this sentence <link linkend='nextsect'>this</link>
word is hot and points to the following section.
</para>
<section xml:id='nextsect'>
<title xml:id='nextsect.title'>A Subsection</title>
<para>
This section only exists to be the target of a couple
of links.
</para>
</section>
</section>
</article>