stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/prefer.internal.olink.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="prefer.internal.olink">\r
   7 <refmeta>\r
   8 <refentrytitle>prefer.internal.olink</refentrytitle>\r
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
  10 </refmeta>\r
  11 <refnamediv>\r
  12 <refname>prefer.internal.olink</refname>\r
  13 <refpurpose>Prefer a local olink reference to an external reference</refpurpose>\r
  14 </refnamediv>\r
  15 \r
  16 <refsynopsisdiv>\r
  17 <src:fragment xml:id="prefer.internal.olink.frag">\r
  18 <xsl:param name="prefer.internal.olink" select="0"/>\r
  19 </src:fragment>\r
  20 </refsynopsisdiv>\r
  21 \r
  22 <refsection><info><title>Description</title></info>\r
  23 \r
  24 <para>If you are re-using XML content modules in multiple documents,\r
  25 you may want to redirect some of your olinks.  This parameter\r
  26 permits you to redirect an olink to the current document.\r
  27 </para>\r
  28 \r
  29 <para>For example: you are writing documentation for a  product, \r
  30 which includes 3 manuals: a little installation\r
  31 booklet (booklet.xml), a user \r
  32 guide (user.xml), and a reference manual (reference.xml).\r
  33 All 3 documents begin with the same introduction section (intro.xml) that \r
  34 contains a reference to the customization section (custom.xml) which is \r
  35 included in both user.xml and reference.xml documents.\r
  36 </para>\r
  37 \r
  38 <para>How do you write the link to custom.xml in intro.xml\r
  39 so that it is interpreted correctly in all 3 documents?</para>\r
  40 <itemizedlist>\r
  41 <listitem><para>If you use xref, it will fail in user.xml.</para>\r
  42 </listitem>\r
  43 <listitem><para>If you use olink (pointing to reference.xml),\r
  44 the reference in user.xml  \r
  45 will point to the customization section of the reference manual, while it is \r
  46 actually available in user.xml.</para>\r
  47 </listitem>\r
  48 </itemizedlist>\r
  49 \r
  50 <para>If you set the <parameter>prefer.internal.olink</parameter>\r
  51 parameter to a non-zero value, then the processor will\r
  52 first look in the olink database\r
  53 for the olink's <tag>targetptr</tag> attribute value\r
  54 in document matching the <parameter>current.docid</parameter>\r
  55 parameter value.  If it isn't found there, then\r
  56 it tries the document in the database\r
  57 with the <tag>targetdoc</tag>\r
  58 value that matches the olink's <tag>targetdoc</tag>\r
  59 attribute.\r
  60 </para>\r
  61 \r
  62 <para>This feature permits an olink reference to resolve to\r
  63 the current document if there is an element\r
  64 with an id matching the olink's <tag>targetptr</tag>\r
  65 value.  The current document's olink data must be\r
  66 included in the target database for this to work.</para>\r
  67 \r
  68 <caution>\r
  69 <para>There is a potential for incorrect links if\r
  70 the same <tag>id</tag> attribute value is used for different\r
  71 content in different documents.\r
  72 Some of your olinks may be redirected to the current document\r
  73 when they shouldn't be.  It is not possible to control\r
  74 individual olink instances.</para>\r
  75 </caution>\r
  76 \r
  77 </refsection>\r
  78 </refentry>\r