stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/insert.olink.pdf.frag.xml

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