1<refentry id="insert.olink.pdf.frag">
2<refmeta>
3<refentrytitle>insert.olink.pdf.frag</refentrytitle>
4<refmiscinfo role="type">boolean</refmiscinfo>
5</refmeta>
6<refnamediv>
7<refname>insert.olink.pdf.frag</refname>
8<refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
9</refnamediv>
10
11<refsynopsisdiv>
12<src:fragment id='insert.olink.pdf.frag.frag'>
13<xsl:param name="insert.olink.pdf.frag" select="0"/>
14</src:fragment>
15</refsynopsisdiv>
16
17<refsect1><title>Description</title>
18
19<para>The value of this parameter determines whether
20the cross reference URIs to PDF documents made with
21<sgmltag>olink</sgmltag> will 
22include fragment identifiers.
23</para>
24
25<para>When forming a URI to link to a PDF document,
26a fragment identifier (typically a '#' followed by an
27id value) appended to the PDF filename can be used by
28the PDF viewer to open
29the PDF file to a location within the document instead of
30the first page.
31However, not all PDF files have id
32values embedded in them, and not all PDF viewers can
33handle fragment identifiers. 
34</para>
35
36<para>If <parameter>insert.olink.pdf.frag</parameter> is set
37to a non-zero value, then any olink targeting a
38PDF file will have the fragment identifier appended to the URI.
39The URI is formed by concatenating the value of the
40<parameter>olink.base.uri</parameter> parameter, the
41value of the <sgmltag class="attribute">baseuri</sgmltag>
42attribute from the <sgmltag class="element">document</sgmltag>
43element in the olink database with the matching
44<sgmltag class="attribute">targetdoc</sgmltag> value,
45and the value of the <sgmltag class="attribute">href</sgmltag>
46attribute for the targeted element in the olink database.
47The <sgmltag class="attribute">href</sgmltag> attribute
48contains the fragment identifier.
49</para>
50
51<para>If <parameter>insert.olink.pdf.frag</parameter> is set
52to zero (the default value), then 
53the <sgmltag class="attribute">href</sgmltag> attribute
54from the olink database
55is not appended to PDF olinks, so the fragment identifier is left off.
56A PDF olink is any olink for which the
57<sgmltag class="attribute">baseuri</sgmltag> attribute
58from the matching <sgmltag class="element">document</sgmltag>
59element in the olink database ends with '.pdf'.
60Any other olinks will still have the fragment identifier added.
61</para>
62</refsect1>
63</refentry>
64