stylesheets/styleguide/docbook-xsl-1.75.2/params/olink.lang.fallback.sequence.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.lang.fallback.sequence"> \r
   7 <refmeta> \r
   8 <refentrytitle>olink.lang.fallback.sequence</refentrytitle> \r
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> \r
  10 </refmeta> \r
  11 <refnamediv> \r
  12 <refname>olink.lang.fallback.sequence</refname> \r
  13 <refpurpose>look up translated documents if olink not found?</refpurpose>\r
  14 \r
  15 </refnamediv> \r
  16 <refsynopsisdiv> <src:fragment xml:id="olink.lang.fallback.sequence.frag">\r
  17 <xsl:param name="olink.lang.fallback.sequence"></xsl:param>\r
  18 </src:fragment> \r
  19 </refsynopsisdiv> \r
  20 <refsection><info><title>Description</title></info> \r
  21  \r
  22 \r
  23 <para>This parameter defines a list of lang values\r
  24 to search among to resolve olinks.\r
  25 </para>\r
  26 \r
  27 <para>Normally an olink tries to resolve to a document in the same\r
  28 language as the olink itself.  The language of an olink\r
  29 is determined by its nearest ancestor element with a\r
  30 <tag class="attribute">lang</tag> attribute, otherwise the\r
  31 value of the <parameter>l10n.gentext.default.lang</parameter>\r
  32 parameter.\r
  33 </para>\r
  34 \r
  35 <para>An olink database can contain target data for the same\r
  36 document in multiple languages.  Each set of data has the\r
  37 same value for the <tag>targetdoc</tag> attribute in\r
  38 the <tag>document</tag> element in the database, but with a \r
  39 different <tag>lang</tag> attribute value.\r
  40 </para>\r
  41 \r
  42 <para>When an olink is being resolved, the target is first\r
  43 sought in the document with the same language as the olink.\r
  44 If no match is found there, then this parameter is consulted\r
  45 for additional languages to try.</para>\r
  46 \r
  47 <para>The <parameter>olink.lang.fallback.sequence</parameter>\r
  48 must be a whitespace separated list of lang values to\r
  49 try.  The first one with a match in the olink database is used.\r
  50 The default value is empty.</para>\r
  51 \r
  52 <para>For example, a document might be written in German\r
  53 and contain an olink with\r
  54 <literal>targetdoc="adminguide"</literal>.\r
  55 When the document is processed, the processor\r
  56 first looks for a target dataset in the\r
  57 olink database starting with:</para>\r
  58 \r
  59 <literallayout><literal>&lt;document targetdoc="adminguide" lang="de"&gt;</literal>.\r
  60 </literallayout>\r
  61 \r
  62 <para>If there is no such element, then the\r
  63 <parameter>olink.lang.fallback.sequence</parameter> \r
  64 parameter is consulted.\r
  65 If its value is, for example, <quote>fr en</quote>, then the processor next\r
  66 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and\r
  67 then for <literal>targetdoc="adminguide" lang="en"</literal>.\r
  68 If there is still no match, it looks for\r
  69 <literal>targetdoc="adminguide"</literal> with no\r
  70 lang attribute.\r
  71 </para>\r
  72 \r
  73 <para>This parameter is useful when a set of documents is only\r
  74 partially translated, or is in the process of being translated.  \r
  75 If a target of an olink has not yet been translated, then this\r
  76 parameter permits the processor to look for the document in\r
  77 other languages.  This assumes the reader would rather have\r
  78 a link to a document in a different language than to have\r
  79 a broken link.\r
  80 </para>\r
  81 \r
  82 </refsection> \r
  83 </refentry>\r