xref
xref — A cross reference to another part of the document.
Synopsis
- empty
Attributes
Common attributes and common linking attributes.
Additional attributes:
- endterm (IDREF)
- xrefstyle
Required attributes are shown in bold.
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:
If the
endtermattribute is specified onxref, the content of the element pointed to byendtermwill be used as the text of the cross-reference.Otherwise, if the object pointed to has a specified
xreflabel, the content of that attribute will be used as the cross-reference text.Finally, the author may specify a keyword (or other information) in the
xrefstyleattribute. Unlikeendtermandxreflabelwhich have rigid semantics, the content of thexrefstyleattribute 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 style information
Parents ![[+]](figs/web/nav/right.gif)
![[+]](figs/web/nav/down.gif)
Examples
1 <book xmlns='http://docbook.org/ns/docbook'> 2 <title>An Example Book</title> 4 <chapter xml:id="ch01"><title>XRef Samples</title> <para>This paragraph demonstrates several features of <tag>XRef</tag>. 6 </para> 8 <itemizedlist> <listitem><para>A straight link generates the cross-reference text: 10 <xref linkend="ch02"/>. </para></listitem> 12 <listitem><para>A link to an element with an <tag class="attribute">XRefLabel</tag>: 14 <xref linkend="ch03"/>. </para></listitem> 16 <listitem><para>A link with an <tag class="attribute">EndTerm</tag>: <xref linkend="ch04" endterm="ch04short"/>. 18 </para></listitem> </itemizedlist> 20 </chapter> 22 <chapter xml:id="ch02"> <title>The Second Chapter</title> 24 <para>Some content here</para> </chapter> 26 <chapter xml:id="ch03" xreflabel="Chapter the Third"> 28 <title>The Third Chapter</title> <para>Some content here</para> 30 </chapter> 32 <chapter xml:id="ch04"> <title>The Fourth Chapter</title> 34 <titleabbrev xml:id="ch04short">Chapter 4</titleabbrev> <para>Some content here</para> 36 </chapter> </book>