OLD | NEW |
| (Empty) |
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.olink.page.number"> | |
7 <refmeta> | |
8 <refentrytitle>insert.olink.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.olink.page.number</refname> | |
16 <refpurpose>Turns page numbers in olinks on and off</refpurpose> | |
17 </refnamediv> | |
18 | |
19 <refsynopsisdiv> | |
20 <src:fragment xml:id="insert.olink.page.number.frag"> | |
21 <xsl:param name="insert.olink.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 made between documents with | |
29 <tag>olink</tag> will | |
30 include page number citations. | |
31 In most cases this is only applicable to references in printed output. | |
32 </para> | |
33 <para>The parameter has three possible values. | |
34 </para> | |
35 <variablelist> | |
36 <varlistentry> | |
37 <term>no</term> | |
38 <listitem><para>No page number references will be generated for olinks. | |
39 </para></listitem> | |
40 </varlistentry> | |
41 <varlistentry> | |
42 <term>yes</term> | |
43 <listitem><para>Page number references will be generated | |
44 for all <tag>olink</tag> references. | |
45 The style of page reference may be changed | |
46 if an <tag class="attribute">xrefstyle</tag> | |
47 attribute is used. | |
48 </para></listitem> | |
49 </varlistentry> | |
50 <varlistentry> | |
51 <term>maybe</term> | |
52 <listitem><para>Page number references will not be generated | |
53 for an <tag>olink</tag> element unless | |
54 it has an | |
55 <tag class="attribute">xrefstyle</tag> | |
56 attribute whose value specifies a page reference. | |
57 </para></listitem> | |
58 </varlistentry> | |
59 </variablelist> | |
60 <para>Olinks that point to targets within the same document | |
61 are treated as <tag>xref</tag>s, and controlled by | |
62 the <parameter>insert.xref.page.number</parameter> parameter. | |
63 </para> | |
64 | |
65 <para>Page number references for olinks to | |
66 external documents can only be inserted if the | |
67 information exists in the olink database. | |
68 This means each olink target element | |
69 (<tag>div</tag> or <tag>obj</tag>) | |
70 must have a <tag class="attribute">page</tag> attribute | |
71 whose value is its page number in the target document. | |
72 The XSL stylesheets are not able to extract that information | |
73 during processing because pages have not yet been created in | |
74 XSLT transformation. Only the XSL-FO processor knows what | |
75 page each element is placed on. | |
76 Therefore some postprocessing must take place to populate | |
77 page numbers in the olink database. | |
78 </para> | |
79 | |
80 | |
81 | |
82 </refsection> | |
83 </refentry> | |
OLD | NEW |