]> git.stg.codes - stg.git/blob - doc/xslt/params/l10n.gentext.use.xref.language.xml
More clear plugin API
[stg.git] / doc / xslt / params / l10n.gentext.use.xref.language.xml
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="l10n.gentext.use.xref.language">
7 <refmeta>
8 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>l10n.gentext.use.xref.language</refname>
13 <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="l10n.gentext.use.xref.language.frag">
18 <xsl:param name="l10n.gentext.use.xref.language" select="0"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>If non-zero, the language of the target will be used when
25 generating cross reference text. Usually, the <quote>current</quote>
26 language is used when generating text (that is, the language of the
27 element that contains the cross-reference element). But setting this parameter
28 allows the language of the element <emphasis>pointed to</emphasis> to control
29 the generated text.</para>
30
31 <para>Consider the following example:</para>
32
33 <informalexample>
34 <programlisting>&lt;para lang="en"&gt;See also &lt;xref linkend="chap3"/&gt;.&lt;/para&gt;
35 </programlisting>
36 </informalexample>
37
38 <para>Suppose that Chapter 3 happens to be written in German.
39 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
40 resulting text will be something like this:</para>
41
42 <blockquote>
43 <para>See also Kapital 3.</para>
44 </blockquote>
45
46 <para>Where the more traditional rendering would be:</para>
47
48 <blockquote>
49 <para>See also Chapter 3.</para>
50 </blockquote>
51
52 </refsection>
53 </refentry>