~ubuntu-branches/ubuntu/trusty/docbook-xsl-doc/trusty

« back to all changes in this revision

Viewing changes to doc/fo/insert.olink.page.number.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Leidert (dale)
  • Date: 2009-03-14 15:13:12 UTC
  • Revision ID: james.westby@ubuntu.com-20090314151312-31veakxfen1x36in
Tags: upstream-1.74.3
Import upstream version 1.74.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>insert.olink.page.number</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.3"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: Reference�Documentation"><link rel="up" href="links.html" title="Linking"><link rel="prev" href="collect.xref.targets.html" title="collect.xref.targets"><link rel="next" href="insert.olink.pdf.frag.html" title="insert.olink.pdf.frag"><link rel="copyright" href="copyright.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">insert.olink.page.number</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="collect.xref.targets.html">Prev</a>�</td><th width="60%" align="center">Linking</th><td width="20%" align="right">�<a accesskey="n" href="insert.olink.pdf.frag.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="insert.olink.page.number"></a><div class="titlepage"></div>
 
2
 
 
3
<div class="refnamediv"><h2><span class="refentrytitle">insert.olink.page.number</span></h2><p>
 
4
insert.olink.page.number
 
5
 &#8212; Turns page numbers in olinks on and off
 
6
</p></div>
 
7
 
 
8
<div class="refsynopsisdiv"><h2>Synopsis</h2>
 
9
<a name="insert.olink.page.number.frag"></a><pre class="programlisting">
 
10
&lt;xsl:param name="insert.olink.page.number"&gt;no&lt;/xsl:param&gt;
 
11
</pre>
 
12
</div>
 
13
 
 
14
<div class="refsection" lang="en"><a name="id1412313"></a><h2>Description</h2>
 
15
 
 
16
<p>The value of this parameter determines if
 
17
cross references made between documents with
 
18
<a href="http://docbook.org/tdg5/en/html/olink.html"><code class="sgmltag-element">olink</code></a> will 
 
19
include page number citations.
 
20
In most cases this is only applicable to references in printed output.
 
21
</p>
 
22
<p>The parameter has three possible values.
 
23
</p>
 
24
<div class="variablelist"><dl><dt><span class="term">no</span></dt><dd><p>No page number references will be generated for olinks.
 
25
</p></dd><dt><span class="term">yes</span></dt><dd><p>Page number references will be generated
 
26
for all <a href="http://docbook.org/tdg5/en/html/olink.html"><code class="sgmltag-element">olink</code></a> references.
 
27
The style of page reference may be changed
 
28
if an <code class="sgmltag-attribute">xrefstyle</code>
 
29
attribute is used.
 
30
</p></dd><dt><span class="term">maybe</span></dt><dd><p>Page number references will not be generated
 
31
for an <a href="http://docbook.org/tdg5/en/html/olink.html"><code class="sgmltag-element">olink</code></a> element unless 
 
32
it has an
 
33
<code class="sgmltag-attribute">xrefstyle</code>
 
34
attribute whose value specifies a page reference.
 
35
</p></dd></dl></div>
 
36
<p>Olinks that point to targets within the same document
 
37
are treated as <a href="http://docbook.org/tdg5/en/html/xref.html"><code class="sgmltag-element">xref</code></a>s, and controlled by
 
38
the <a href="../html/insert.xref.page.number.html"><em class="parameter"><code>insert.xref.page.number</code></em></a> parameter.
 
39
</p>
 
40
 
 
41
<p>Page number references for olinks to
 
42
external documents can only be inserted if the 
 
43
information exists in the olink database. 
 
44
This means each olink target element 
 
45
(<code class="sgmltag-element">div</code> or <code class="sgmltag-element">obj</code>)
 
46
must have a <code class="sgmltag-attribute">page</code> attribute
 
47
whose value is its page number in the target document.
 
48
The XSL stylesheets are not able to extract that information
 
49
during processing because pages have not yet been created in
 
50
XSLT transformation.  Only the XSL-FO processor knows what
 
51
page each element is placed on.
 
52
Therefore some postprocessing must take place to populate
 
53
page numbers in the olink database.
 
54
</p>
 
55
 
 
56
 
 
57
 
 
58
</div>
 
59
</div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="collect.xref.targets.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="links.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="insert.olink.pdf.frag.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">collect.xref.targets�</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">�insert.olink.pdf.frag</td></tr></table></div></body></html>
 
60