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