O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

xref — A cross-reference to another part of the document

Synopsis

xref ::= empty

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • endterm (IDREF)

  • xrefstyle

Description

The xref element forms a cross-reference from the location of the xref to the element to which it points. Unlike link and the other cross-referencing elements, xref is empty. The processing system has to generate appropriate cross-reference text for the reader.

Processing expectations

Under ordinary circumstances, the xref points to some element with its linkend attribute and the processing system generates appropriate cross-reference text. There are three ways for the author to influence the generated text:

  1. If the endterm attribute is specified on xref, the content of the element pointed to by endterm will be used as the text of the cross-reference.

  2. Otherwise, if the object pointed to has a specified xreflabel, the content of that attribute will be used as the cross-reference text.

  3. Finally, the author may specify a keyword (or other information) in the xrefstyle attribute. Unlike endterm and xreflabel which have rigid semantics, the content of the xrefstyle attribute is simply additional information for the processing system. What effect it has, if any, is dependent on the processing system.

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

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required