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