$prefer-xrefstyle — Always use xrefstyle if present on xref .

Parameter:
{}prefer-xrefstyle
Defined in:
param.xsl
Used in:
main.xsl, param.xsl
Since:
2.8.0

Synopsis

$prefer-xrefstyle as xs:string := 'false'

Description

The processing expectations of xref from DocBook: The Definitive Guide are shown in Figure 1, “Processing expectations of the xref element”.

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.

Figure 1. Processing expectations of the xref element

This hierarchy has the unfortunate consequence that once an element has an xreflabel, any xref that links to it will ignore the xrefstyle attribute on the xref.

If $prefer-xrefstyle is true, then xrefstyle is given higher priority than xreflabel. This parameter is false by default for backwards compatibility (and conformance to the guide).