link

link — A hypertext link

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • endterm (IDREF)
  • xrefstyle

Required attributes are show in bold.

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 a 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

FIXME:

xrefstyle

FIXME:

Parents

These elements contain link: abbrev, accel, acronym, address, application, arg, artpagenums, attribution, authorinitials, bibliocoverage, biblioid, bibliomisc, bibliomset, bibliorelation, bibliosource, bridgehead, citation, citebiblioid, citetitle, city, classname, classsynopsisinfo, code, command, computeroutput, confdates, confnum, confsponsor, conftitle, constant, contractnum, contractsponsor, contrib, country, database, edition, email, emphasis (db._emphasis), emphasis (db.emphasis), entry, envar, errorcode, errorname, errortext, errortype, exceptionname, fax, filename, firstname, firstterm, foreignphrase, funcdef, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, holder, honorific, html:button, html:label, html:legend, initializer, interfacename, issuenum, jobtitle, keycap, keycode, keysym, label, lineage, lineannotation, link, literal, literallayout, manvolnum, markup, mathphrase, member, methodname, modifier, mousebutton, msgaud, msglevel, msgorig, olink, option, optional, orgdiv, orgname, otheraddr, othername, package, pagenums, para, paramdef, parameter, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, postcode, primary, primaryie, productname, productnumber, programlisting, prompt, property, publishername, quote, refdescriptor, refentrytitle, refmiscinfo, refname, refpurpose, releaseinfo, remark, replaceable, returnvalue, revnumber, revremark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, seriesvolnums, shortaffil, simpara, state, street, subscript, subtitle, superscript, surname, symbol, synopsis, systemitem, tag, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, token, trademark, type, uri, userinput, varname, volumenum, wordasword, year.

See Also

anchor, olink, xref

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>

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:55 $.