1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
<?xml version="1.0"?>
<page xmlns="http://projectmallard.org/1.0/" id="l10n.gettext" type="topic" style="xslt-template"><info><link type="guide" xref="l10n" group="templates"/><link type="guide" xref="templates" group="l10n"/><revision version="3.18" date="2015-07-29" status="final"/><desc>Look up the translation for a string.</desc></info><title>l10n.gettext</title><p>Look up the translation for a string.</p>
<synopsis><title>Parameters</title><terms>
<item>
<title><code>domain</code></title>
<p>The domain to look up the string in.</p>
</item>
<item>
<title><code>msgid</code></title>
<p>The id of the string to look up, often the string in the C locale.</p>
</item>
<item>
<title><code>lang</code></title>
<p>The locale to use when looking up the translated string.</p>
</item>
<item>
<title><code>number</code></title>
<p>The cardinality for plural-form lookups.</p>
</item>
<item>
<title><code>form</code></title>
<p>The form name for plural-form lookups.</p>
</item>
<item>
<title><code>format</code></title>
<p>Whether to treat the result as a format string.</p>
</item>
<item>
<title><code>node</code></title>
<p>A context node to pass to <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>.</p>
</item>
<item>
<title><code>string</code></title>
<p>A string to pass to <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code> for <code>msg:string</code> elements.</p>
</item>
</terms></synopsis>
<p>This template extracts a translated version of a source string. In simple cases, the source string is exactly the string in <code style="xslt-param">msgid</code>, though in more complex cases, the <code style="xslt-param">msgid</code> parameter is a separate unique identifier.</p>
<p>This template looks up the translation in a message catalog file based on the <code style="xslt-param">domain</code> parameter. The file must be in a <code>domains</code> subdirectory relative to the directory holding this stylesheet and be named the same as <code style="xslt-param">domain</code> with the suffix <code>.xml</code>. This template will fail if no such file is found. By default, the domain is <code>yelp-xsl</code> to reference the translations shipped with these stylesheets. Extensions and third-party stylesheets, however, can use this template by installing a file and passing the <code style="xslt-param">domain</code> parameter.</p>
<p>The message catalog file format is designed to work with the XML/PO translation tool <code>itstool</code>, using its join mode to create a single polylingual file. There is no tool to automatically extract messages from XSLT files. You must add messages to the source catalog file when adding translatable strings.</p>
<p>The message catalog file contains a set of <code>msg</code> elements, one for each string that needs translation. Each <code>msg</code> element has an <code>id</code> attribute. It is this attribute that is matched against the <code style="xslt-param">msgid</code> parameter. Each <code>msg</code> element then has one or more <code>msgstr</code> elements, each with an <code>xml:lang</code> attribute. This template tries to find a best match language with the <code style="xslt-param">lang</code> parameter, falling back to a <code>msgstr</code> element with no <code>xml:lang</code> attribute.</p>
<p>In a source message catalog file, put the string to be translated inside a singleton <code>msgstr</code> element in each <code>msg</code> element, without an <code>xml:lang</code> parameter. Add this element even if it is the same as the <code>id</code> attribute of the <code>msg</code> element. These <code>msgstr</code> elements are what <code>itstool</code> uses to create a PO file, and it provides the fallback string when no language matches.</p>
<p>The <code>xml:lang</code> attribute should contain an RFC 3066 language identifier, which is different from the POSIX locale identifiers used by gettext. To accommodate this difference, this stylesheet converts all identifiers to lowercase and replaces the characters <code>_</code>, <code>@</code>, and <code>.</code> with the character <code>-</code>. If it cannot find an exact match, it strips the part after the last <code>-</code> and looks again. It repeats this as long as the identifier contains a <code>-</code> character. If there is still no matching <code>msgstr</code> element, it looks for one with no <code>xml:lang</code> attribute.</p>
<p>Sometimes you have to provide different versions of a string for different cardinalities. While English and many other languages have singular and plural, some languages have no plural forms, while others have as many as six. These stylesheets use a numeric index for plural forms, similarly to gettext. To get the string for a plural, pass the cardinality in the <code style="xslt-param">number</code> parameter. This template gets an index for that number by calling <code style="xslt-template" xref="l10n.plural.form">l10n.plural.form</code>. The plural form index is in the <code style="xslt-param">form</code> parameter. You do not have to pass this parameter. It will be computed automatically based on the <code style="xslt-param">number</code> parameter.</p>
<p>There is currently no support for editing plural forms using the standard PO syntax. Instead, plurals are defined with an XML snippet. Instead of putting the single translated message in the <code>msgstr</code> element, plural messages have <code>msgstr</code> child elements of the <code>msgstr</code> element with the <code>xml:lang</code> attribute. Each of these child <code>msgstr</code> elements has a <code>form</code> attribute that holds the numeric index returned by <code style="xslt-template" xref="l10n.plural.form">l10n.plural.form</code>. Translators must adapt the XML snippet according to the plural rules and forms defined in this stylesheet for their language.</p>
<p>Some translations aren't simple strings, but are instead format strings where certain values are inserted. This template can handle format strings with XML marker elements to signal where values should be substituted. These values can be the result of applying templates.</p>
<p>To enable format strings, set the <code style="xslt-param">format</code> parameter to <code>true()</code>. Instead of just returning the translated string, this template will apply templates in the mode <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code> to the fragment contained in the <code>msgstr</code> element.</p>
<p>The <code style="xslt-param">node</code> and <code style="xslt-param">string</code> parameters are passed to templates in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>. This stylesheet contains matches in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code> for the marker elements <code><string/></code> and <code><node/></code>. The element <code><string/></code> will be replaced by the string value of <code style="xslt-param">string</code>. The element <code><node/></code> will apply templates without a mode to <code style="xslt-param">node</code>. Text nodes are copied to the result in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>.</p>
<p>If you need any other behavior, add elements with any name of your choosing to the format string, then match on those elements in <code style="xslt-mode" xref="l10n.format.mode">l10n.format.mode</code>. You will be able to use the <code style="xslt-param">node</code> and <code style="xslt-param">string</code> parameters in your template. Try to use a name that is unique.</p>
<list style="compact"><title>Calls Templates</title><item><p><link xref="l10n.plural.form"/></p></item><item><p><link xref="l10n.gettext"/></p></item></list><list style="compact"><title>Calls Keys</title><item><p><link xref="l10n.msgstr.key"/></p></item></list></page>
|
