insert.link.page.number.xml 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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.link.page.number">
  7. <refmeta>
  8. <refentrytitle>insert.link.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.link.page.number</refname>
  16. <refpurpose>Turns page numbers in link elements on and off</refpurpose>
  17. </refnamediv>
  18. <refsynopsisdiv>
  19. <src:fragment xml:id="insert.link.page.number.frag">
  20. <xsl:param name="insert.link.page.number">no</xsl:param>
  21. </src:fragment>
  22. </refsynopsisdiv>
  23. <refsection><info><title>Description</title></info>
  24. <para>The value of this parameter determines if
  25. cross references using the <tag>link</tag> element in
  26. printed output will
  27. include standard page number citations.
  28. It has three possible values.
  29. </para>
  30. <variablelist>
  31. <varlistentry>
  32. <term>no</term>
  33. <listitem><para>No page number references will be generated.
  34. </para></listitem>
  35. </varlistentry>
  36. <varlistentry>
  37. <term>yes</term>
  38. <listitem><para>Page number references will be generated
  39. for all <tag>link</tag> elements.
  40. The style of page reference may be changed
  41. if an <tag class="attribute">xrefstyle</tag>
  42. attribute is used.
  43. </para></listitem>
  44. </varlistentry>
  45. <varlistentry>
  46. <term>maybe</term>
  47. <listitem><para>Page number references will not be generated
  48. for a <tag>link</tag> element unless
  49. it has an
  50. <tag class="attribute">xrefstyle</tag>
  51. attribute whose value specifies a page reference.
  52. </para></listitem>
  53. </varlistentry>
  54. </variablelist>
  55. <para>Although the <tag>xrefstyle</tag> attribute
  56. can be used to turn the page reference on or off, it cannot be
  57. used to control the formatting of the page number as it
  58. can in <tag>xref</tag>.
  59. In <tag>link</tag> it will always format with
  60. the style established by the
  61. gentext template with <literal>name="page.citation"</literal>
  62. in the <literal>l:context name="xref"</literal>.
  63. </para>
  64. </refsection>
  65. </refentry>