doc/xslt/params/insert.xref.page.number.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"
   2           xmlns:xlink="http://www.w3.org/1999/xlink"
   3           xmlns:xi="http://www.w3.org/2001/XInclude"
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   6           version="5.0" xml:id="insert.xref.page.number">
   7 <refmeta>
   8 <refentrytitle>insert.xref.page.number</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  10 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  11 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  12 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
  13 </refmeta>
  14 <refnamediv>
  15 <refname>insert.xref.page.number</refname>
  16 <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20 <src:fragment xml:id="insert.xref.page.number.frag">
  21 <xsl:param name="insert.xref.page.number">no</xsl:param>
  22 </src:fragment>
  23 </refsynopsisdiv>
  24
  25 <refsection><info><title>Description</title></info>
  26
  27 <para>The value of this parameter determines if
  28 cross references (<tag>xref</tag>s) in
  29 printed output will
  30 include page number citations.
  31 It has three possible values.
  32 </para>
  33 <variablelist>
  34 <varlistentry>
  35 <term>no</term>
  36 <listitem><para>No page number references will be generated.
  37 </para></listitem>
  38 </varlistentry>
  39 <varlistentry>
  40 <term>yes</term>
  41 <listitem><para>Page number references will be generated
  42 for all <tag>xref</tag> elements.
  43 The style of page reference may be changed
  44 if an <tag class="attribute">xrefstyle</tag>
  45 attribute is used.
  46 </para></listitem>
  47 </varlistentry>
  48 <varlistentry>
  49 <term>maybe</term>
  50 <listitem><para>Page number references will not be generated
  51 for an <tag>xref</tag> element unless
  52 it has an
  53 <tag class="attribute">xrefstyle</tag>
  54 attribute whose value specifies a page reference.
  55 </para></listitem>
  56 </varlistentry>
  57 </variablelist>
  58
  59 </refsection>
  60 </refentry>