stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/insert.olink.page.number.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"\r
   2           xmlns:xlink="http://www.w3.org/1999/xlink"\r
   3           xmlns:xi="http://www.w3.org/2001/XInclude"\r
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
   6           version="5.0" xml:id="insert.olink.page.number">\r
   7 <refmeta>\r
   8 <refentrytitle>insert.olink.page.number</refentrytitle>\r
   9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> \r
  10 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>\r
  11 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>\r
  12 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>\r
  13 </refmeta>\r
  14 <refnamediv>\r
  15 <refname>insert.olink.page.number</refname>\r
  16 <refpurpose>Turns page numbers in olinks on and off</refpurpose>\r
  17 </refnamediv>\r
  18 \r
  19 <refsynopsisdiv>\r
  20 <src:fragment xml:id="insert.olink.page.number.frag">\r
  21 <xsl:param name="insert.olink.page.number">no</xsl:param>\r
  22 </src:fragment>\r
  23 </refsynopsisdiv>\r
  24 \r
  25 <refsection><info><title>Description</title></info>\r
  26 \r
  27 <para>The value of this parameter determines if\r
  28 cross references made between documents with\r
  29 <tag>olink</tag> will \r
  30 include page number citations.\r
  31 In most cases this is only applicable to references in printed output.\r
  32 </para>\r
  33 <para>The parameter has three possible values.\r
  34 </para>\r
  35 <variablelist>\r
  36 <varlistentry>\r
  37 <term>no</term>\r
  38 <listitem><para>No page number references will be generated for olinks.\r
  39 </para></listitem>\r
  40 </varlistentry>\r
  41 <varlistentry>\r
  42 <term>yes</term>\r
  43 <listitem><para>Page number references will be generated\r
  44 for all <tag>olink</tag> references.\r
  45 The style of page reference may be changed\r
  46 if an <tag class="attribute">xrefstyle</tag>\r
  47 attribute is used.\r
  48 </para></listitem>\r
  49 </varlistentry>\r
  50 <varlistentry>\r
  51 <term>maybe</term>\r
  52 <listitem><para>Page number references will not be generated\r
  53 for an <tag>olink</tag> element unless \r
  54 it has an\r
  55 <tag class="attribute">xrefstyle</tag>\r
  56 attribute whose value specifies a page reference.\r
  57 </para></listitem>\r
  58 </varlistentry>\r
  59 </variablelist>\r
  60 <para>Olinks that point to targets within the same document\r
  61 are treated as <tag>xref</tag>s, and controlled by\r
  62 the <parameter>insert.xref.page.number</parameter> parameter.\r
  63 </para>\r
  64 \r
  65 <para>Page number references for olinks to\r
  66 external documents can only be inserted if the \r
  67 information exists in the olink database. \r
  68 This means each olink target element \r
  69 (<tag>div</tag> or <tag>obj</tag>)\r
  70 must have a <tag class="attribute">page</tag> attribute\r
  71 whose value is its page number in the target document.\r
  72 The XSL stylesheets are not able to extract that information\r
  73 during processing because pages have not yet been created in\r
  74 XSLT transformation.  Only the XSL-FO processor knows what\r
  75 page each element is placed on.\r
  76 Therefore some postprocessing must take place to populate\r
  77 page numbers in the olink database.\r
  78 </para>\r
  79 \r
  80 \r
  81 \r
  82 </refsection>\r
  83 </refentry>\r