stylesheets/styleguide/docbook-xsl-1.75.2/params/olink.doctitle.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="olink.doctitle"> \r
   7 <refmeta> \r
   8 <refentrytitle>olink.doctitle</refentrytitle> \r
   9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> \r
  10 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>\r
  11 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>\r
  12 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>\r
  13 </refmeta> \r
  14 <refnamediv> \r
  15 <refname>olink.doctitle</refname> \r
  16 <refpurpose>show the document title for external olinks?</refpurpose>\r
  17 \r
  18 </refnamediv> \r
  19 <refsynopsisdiv> <src:fragment xml:id="olink.doctitle.frag">\r
  20 <xsl:param name="olink.doctitle">no</xsl:param> \r
  21 </src:fragment> \r
  22 </refsynopsisdiv> \r
  23 <refsection><info><title>Description</title></info> \r
  24  \r
  25 <para>When olinks between documents are resolved, the generated text\r
  26 may not make it clear that the reference is to another document.\r
  27 It is possible for the stylesheets to append the other document's\r
  28 title to external olinks. For this to happen, two parameters must\r
  29 be set.</para>\r
  30 <itemizedlist>\r
  31 <listitem>\r
  32 <para>This <parameter>olink.doctitle</parameter> parameter\r
  33 should be set to either <literal>yes</literal> or <literal>maybe</literal>\r
  34 to enable this feature.\r
  35 </para>\r
  36 </listitem>\r
  37 <listitem>\r
  38 <para>And you should also set the <parameter>current.docid</parameter>\r
  39 parameter to the document id for the  document currently\r
  40 being processed for output.\r
  41 </para>\r
  42 </listitem>\r
  43 </itemizedlist>\r
  44 \r
  45 <para>\r
  46 Then if an olink's  <literal>targetdoc</literal> id differs from\r
  47 the <literal>current.docid</literal> value, the stylesheet knows\r
  48 that it is a reference to another document and can\r
  49 append the target document's\r
  50 title to the generated olink text. </para> \r
  51 \r
  52 <para>The text for the target document's title is copied from the\r
  53 olink database from the <tag>ttl</tag> element\r
  54 of the top-level <tag>div</tag> for that document.\r
  55 If that <tag>ttl</tag> element is missing or empty,\r
  56 no title is output.\r
  57 </para>\r
  58 \r
  59 <para>The supported values for <parameter>olink.doctitle</parameter> are:\r
  60 </para>\r
  61 <variablelist>\r
  62 <varlistentry>\r
  63 <term><literal>yes</literal></term>\r
  64 <listitem>\r
  65 <para>\r
  66 Always insert the title to the target document if it is not\r
  67 the current document.\r
  68 </para>\r
  69 </listitem>\r
  70 </varlistentry>\r
  71 <varlistentry>\r
  72 <term><literal>no</literal></term>\r
  73 <listitem>\r
  74 <para>\r
  75 Never insert the title to the target document, even if requested\r
  76 in an <tag class="attribute">xrefstyle</tag> attribute.\r
  77 </para>\r
  78 </listitem>\r
  79 </varlistentry>\r
  80 <varlistentry>\r
  81 <term><literal>maybe</literal></term>\r
  82 <listitem>\r
  83 <para>\r
  84 Only insert the title to the target document, if requested\r
  85 in an <tag class="attribute">xrefstyle</tag> attribute.\r
  86 </para>\r
  87 </listitem>\r
  88 </varlistentry>\r
  89 </variablelist>\r
  90 <para>An <tag class="attribute">xrefstyle</tag> attribute\r
  91 may override the global setting for individual olinks.\r
  92 The following values are supported in an\r
  93 <tag class="attribute">xrefstyle</tag>\r
  94 attribute using the <literal>select:</literal> syntax:\r
  95 </para>\r
  96 \r
  97 <variablelist>\r
  98 <varlistentry>\r
  99 <term><literal>docname</literal></term>\r
 100 <listitem>\r
 101 <para>\r
 102 Insert the target document name for this olink using the\r
 103 <literal>docname</literal> gentext template, but only\r
 104 if the value of <parameter>olink.doctitle</parameter>\r
 105 is not <literal>no</literal>.\r
 106 </para>\r
 107 </listitem>\r
 108 </varlistentry>\r
 109 <varlistentry>\r
 110 <term><literal>docnamelong</literal></term>\r
 111 <listitem>\r
 112 <para>\r
 113 Insert the target document name for this olink using the\r
 114 <literal>docnamelong</literal> gentext template, but only\r
 115 if the value of <parameter>olink.doctitle</parameter>\r
 116 is not <literal>no</literal>.\r
 117 </para>\r
 118 </listitem>\r
 119 </varlistentry>\r
 120 <varlistentry>\r
 121 <term><literal>nodocname</literal></term>\r
 122 <listitem>\r
 123 <para>\r
 124 Omit the target document name even if\r
 125 the value of <parameter>olink.doctitle</parameter>\r
 126 is <literal>yes</literal>.\r
 127 </para>\r
 128 </listitem>\r
 129 </varlistentry>\r
 130 </variablelist>\r
 131 <para>Another way of inserting the target document name \r
 132 for a single olink is to employ an\r
 133 <tag class="attribute">xrefstyle</tag>\r
 134 attribute using the <literal>template:</literal> syntax.\r
 135 The <literal>%o</literal> placeholder (the letter o, not zero)\r
 136 in such a template\r
 137 will be filled in with the target document's title when it is processed.\r
 138 This will occur regardless of \r
 139 the value of <parameter>olink.doctitle</parameter>.\r
 140 </para>\r
 141 <para>Note that prior to version 1.66 of the XSL stylesheets,\r
 142 the allowed values for this parameter were 0 and 1.  Those\r
 143 values are still supported and mapped to 'no' and 'yes', respectively.\r
 144 </para>\r
 145 </refsection> \r
 146 </refentry>\r