Mercurial > genshi > mirror

annotate doc/i18n.txt @ 885:b7e8b971d90a trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Started extending the i18n docs.
author cmlenz
date Fri, 16 Apr 2010 22:31:38 +0000
parents e97cdbf09a18
children 13017f59f5ea
rev   line source
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
2
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
3 =====================================
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
4 Internationalization and Localization
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
5 =====================================
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
6
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
7 Genshi provides basic supporting infrastructure for internationalizing
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
8 and localizing templates. That includes functionality for extracting
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
9 localizable strings from templates, as well as a template filter that can
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
10 apply translations to templates as they get rendered.
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
11
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
12 This support is based on `gettext`_ message catalogs and the `gettext Python
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
13 module`_. The extraction process can be used from the API level, or through
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
14 the front-ends implemented by the `Babel`_ project, for which Genshi provides
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
15 a plugin.
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
16
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
17 .. _`gettext`: http://www.gnu.org/software/gettext/
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
18 .. _`gettext python module`: http://docs.python.org/lib/module-gettext.html
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
19 .. _`babel`: http://babel.edgewall.org/
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
20
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
21
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
22 .. contents:: Contents
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
23 :depth: 2
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
24 .. sectnum::
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
25
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
26
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
27 Basics
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
28 ======
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
29
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
30 The simplest way to internationalize and translate templates would be to wrap
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
31 all localizable strings in a ``gettext()`` function call (which is often
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
32 aliased to ``_()`` for brevity). In that case, no extra template filter is
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
33 required.
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
34
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
35 .. code-block:: genshi
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
36
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
37 <p>${_("Hello, world!")}</p>
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
38
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
39 However, this approach results in significant “character noise” in templates,
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
40 making them harder to read and preview.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
41
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
42 The ``genshi.filters.Translator`` filter allows you to get rid of the
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
43 explicit `gettext`_ function calls, so you can continue to just write:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
44
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
45 .. code-block:: genshi
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
46
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
47 <p>Hello, world!</p>
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
48
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
49 This text will still be extracted and translated as if you had wrapped it in a
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
50 ``_()`` call.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
51
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
52 .. note:: For parameterized or pluralizable messages, you need to use the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
53 special `template directives`_ described below, or use the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
54 corresponding ``gettext`` function in embedded Python expressions.
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
55
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
56 You can control which tags should be ignored by this process; for example, it
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
57 doesn't really make sense to translate the content of the HTML
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
58 ``<script></script>`` element. Both ``<script>`` and ``<style>`` are excluded
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
59 by default.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
60
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
61 Attribute values can also be automatically translated. The default is to
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
62 consider the attributes ``abbr``, ``alt``, ``label``, ``prompt``, ``standby``,
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
63 ``summary``, and ``title``, which is a list that makes sense for HTML
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
64 documents. Of course, you can tell the translator to use a different set of
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
65 attribute names, or none at all.
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
66
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
67 ----------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
68 Language Tagging
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
69 ----------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
70
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
71 You can control automatic translation in your templates using the ``xml:lang``
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
72 attribute. If the value of that attribute is a literal string, the contents and
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
73 attributes of the element will be ignored:
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
74
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
75 .. code-block:: genshi
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
76
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
77 <p xml:lang="en">Hello, world!</p>
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
78
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
79 On the other hand, if the value of the ``xml:lang`` attribute contains a Python
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
80 expression, the element contents and attributes are still considered for
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
81 automatic translation:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
82
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
83 .. code-block:: genshi
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
84
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
85 <html xml:lang="$locale">
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
86 ...
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
87 </html>
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
88
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
89
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
90 .. _`template directives`:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
91
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
92 Template Directives
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
93 ===================
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
94
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
95 Sometimes localizable strings in templates may contain dynamic parameters, or
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
96 they may depend on the numeric value of some variable to choose a proper
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
97 plural form. Sometimes the strings contain embedded markup, such as tags for
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
98 emphasis or hyperlinks, and you don't want to rely on the people doing the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
99 translations to know the syntax and escaping rules of HTML and XML.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
100
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
101 In those cases the simple text extraction and translation process described
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
102 above is not sufficient. You could just use ``gettext`` API functions in
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
103 embedded Python expressions for parameters and pluralization, but Genshi also
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
104 provides special template directives for internationalization that attempt to
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
105 provide a comprehensive solution for this problem space.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
106
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
107 To enable these directives, you'll need to register them with the templates
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
108 they are used in. You can do this by adding them manually via the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
109 ``Template.add_directives(namespace, factory)`` (where ``namespace`` would be
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
110 “http://genshi.edgewall.org/i18n” and ``factory`` would be an instance of the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
111 ``Translator`` class). Or you can just call the ``Translator.setup(template)``
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
112 class method, which both registers the directives and adds the translation
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
113 filter.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
114
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
115 .. note:: The internationalization directives are still somewhat experimental
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
116 and have some known issues. However, the attribute language they
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
117 implement should be stable and is not subject to change
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
118 substantially in future versions.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
119
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
120
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
121 --------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
122 Messages
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
123 --------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
124
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
125 ``i18n:msg``
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
126 ------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
127
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
128 This is the basic directive for defining localizable text passages that
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
129 contain parameters and/or markup.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
130
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
131 For example, consider the following template snippet:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
132
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
133 .. code-block:: genshi
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
134
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
135 <p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
136 Please visit <a href="${site.url}">${site.name}</a> for help.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
137 </p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
138
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
139 Without further annotation, the translation filter would treat this sentence
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
140 as two separate messages (“Please click” and “here”), and the translator would
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
141 have no control over the position of the link in the sentence.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
142
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
143 However, when you use the Genshi internationalization directives, you simply
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
144 add an ``i18n:msg`` attribute to the enclosing ``<p>`` element:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
145
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
146 .. code-block:: genshi
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
147
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
148 <p i18n:msg="name">
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
149 Please visit <a href="${site.url}">${site.name}</a> for help.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
150 </p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
151
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
152 Genshi is then able to identify the text in the ``<p>`` element as a single
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
153 message for translation purposes. You'll see the following string in your
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
154 message catalog::
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
155
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
156 Please visit [1:%(name)s] for help.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
157
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
158 The `<a>` element with its attribute has been replaced by a part in square
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
159 brackets, which does not include the tag name or the attributes of the element.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
160
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
161 The value of the ``i18n:msg`` attribute is a comma-separated list of parameter
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
162 names, which serve as simplified aliases for the actual Python expressions the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
163 message contains. The order of the paramer names in the list must correspond
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
164 to the order of the expressions in the text. In this example, there is only
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
165 one parameter: its alias for translation is “name”, while the corresponding
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
166 expression is ``${site.name}``.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
167
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
168 The translator now has complete control over the structure of the sentence. He
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
169 or she certainly does need to make sure that any bracketed parts are not
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
170 removed, and that the ``name`` parameter is preserved correctly. But those are
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
171 things that can be easily checked by validating the message catalogs. The
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
172 important thing is that the translator can change the sentence structure, and
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
173 has no way to break the application by forgetting to close a tag, for example.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
174
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
175 So if the German translator of this snippet decided to translate it to::
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
176
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
177 Um Hilfe zu erhalten, besuchen Sie bitte [1:%(name)s]
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
178
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
179 The resulting output might be:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
180
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
181 .. code-block:: html
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
182
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
183 <p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
184 Um Hilfe zu erhalten, besuchen Sie bitte
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
185 <a href="http://example.com/">Example</a>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
186 </p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
187
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
188 Please note that messages may contain multiple tags, and they may also be
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
189 nested. For example:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
190
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
191 .. code-block:: genshi
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
192
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
193 <p i18n:msg="name">
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
194 <i>Please</i> visit <b>the site <a href="${site.url}">${site.name}</a></b>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
195 for help.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
196 </p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
197
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
198 This would result in the following message ID::
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
199
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
200 [1:Please] visit [2:the site [3:%(name)s]] for help.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
201
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
202 Again, the translator has full control over the structure of the sentence. So
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
203 the German translation could actually look like this::
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
204
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
205 Um Hilfe zu erhalten besuchen Sie [1:bitte]
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
206 [3:%(name)s], [2:das ist eine Web-Site]
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
207
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
208 Which Genshi would recompose into the following outout:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
209
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
210 .. code-block:: html
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
211
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
212 <p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
213 Um Hilfe zu erhalten besuchen Sie <i>bitte</i>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
214 <a href="http://example.com/">Example</a>, <b>das ist eine Web-Site</b>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
215 </p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
216
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
217 Note how the translation has changed the order and even the nesting of the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
218 tags.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
219
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
220 .. warning:: Please note that ``i18n:msg`` directives do not support other
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
221 nested directives. Directives commonly change the structure of
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
222 the generated markup dynamically, which often would result in the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
223 structure of the text changing, thus making translation as a
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
224 single message ineffective.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
225
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
226 ``i18n:comment``
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
227 ----------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
228
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
229 The ``i18n:comment`` directive can be used to supply a comment for the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
230 translator. For example, if a template snippet is not easily understood
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
231 outside of its context, you can add a translator comment to help the
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
232 translator understand in what context the message will be used:
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
233
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
234 .. code-block:: genshi
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
235
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
236 <p i18n:msg="name" i18n:comment="Link to the relevant support site">
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
237 Please visit <a href="${site.url}">${site.name}</a> help.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
238 </p>
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
239
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
240 This comment will be extracted together with the message itself, and will
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
241 commonly be placed along the message in the message catalog, so that it is
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
242 easily visible to the person doing the translation.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
243
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
244 This directive has no impact on how the template is rendered, and is ignored
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
245 outside of the extraction process.
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
246
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
247
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
248 -------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
249 Pluralization
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
250 -------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
251
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
252 ``i18n:choose``, ``i18n:singular``, ``i18n:plural``
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
253 ---------------------------------------------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
254
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
255 TODO
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
256
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
257 -------------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
258 Translation Domains
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
259 -------------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
260
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
261 ``i18n:domain``
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
262 ---------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
263
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
264 TODO
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
265
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
266 Extraction
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
267 ==========
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
268
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
269 The ``Translator`` class provides a class method called ``extract``, which is
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
270 a generator yielding all localizable strings found in a template or markup
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
271 stream. This includes both literal strings in text nodes and attribute values,
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
272 as well as strings in ``gettext()`` calls in embedded Python code. See the API
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
273 documentation for details on how to use this method directly.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
274
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
275 -----------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
276 Babel Integration
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
277 -----------------
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
278
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
279 This functionality is integrated with the message extraction framework provided
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
280 by the `Babel`_ project. Babel provides a command-line interface as well as
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
281 commands that can be used from ``setup.py`` scripts using `Setuptools`_ or
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
282 `Distutils`_.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
283
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
284 .. _`setuptools`: http://peak.telecommunity.com/DevCenter/setuptools
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
285 .. _`distutils`: http://docs.python.org/dist/dist.html
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
286
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
287 The first thing you need to do to make Babel extract messages from Genshi
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
288 templates is to let Babel know which files are Genshi templates. This is done
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
289 using a “mapping configuration”, which can be stored in a configuration file,
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
290 or specified directly in your ``setup.py``.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
291
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
292 In a configuration file, the mapping may look like this:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
293
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
294 .. code-block:: ini
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
295
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
296 # Python souce
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
297 [python:**.py]
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
298
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
299 # Genshi templates
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
300 [genshi:**/templates/**.html]
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
301 include_attrs = title
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
302
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
303 [genshi:**/templates/**.txt]
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
304 template_class = genshi.template.TextTemplate
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
305 encoding = latin-1
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
306
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
307 Please consult the Babel documentation for details on configuration.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
308
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
309 If all goes well, running the extraction with Babel should create a POT file
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
310 containing the strings from your Genshi templates and your Python source files.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
311
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
312
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
313 ---------------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
314 Configuration Options
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
315 ---------------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
316
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
317 The Genshi extraction plugin for Babel supports the following options:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
318
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
319 ``template_class``
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
320 ------------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
321 The concrete ``Template`` class that the file should be loaded with. Specify
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
322 the package/module name and the class name, separated by a colon.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
323
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
324 The default is to use ``genshi.template:MarkupTemplate``, and you'll want to
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
325 set it to ``genshi.template:TextTemplate`` for `text templates`_.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
326
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
327 .. _`text templates`: text-templates.html
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
328
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
329 ``encoding``
594
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
330 ------------
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
331 The encoding of the template file. This is only used for text templates. The
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
332 default is to assume “utf-8”.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
333
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
334 ``include_attrs``
594
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
335 -----------------
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
336 Comma-separated list of attribute names that should be considered to have
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
337 localizable values. Only used for markup templates.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
338
594
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
339 ``ignore_tags``
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
340 ---------------
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
341 Comma-separated list of tag names that should be ignored. Only used for markup
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
342 templates.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
343
594
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
344 ``extract_text``
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
345 ----------------
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
346 Whether text outside explicit ``gettext`` function calls should be extracted.
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
347 By default, any text nodes not inside ignored tags, and values of attribute in
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
348 the ``include_attrs`` list are extracted. If this option is disabled, only
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
349 strings in ``gettext`` function calls are extracted.
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
350
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
351 .. note:: If you disable this option, it's not necessary to add the translation
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
352 filter as described above. You only need to make sure that the
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
353 template has access to the ``gettext`` functions it uses.
2bbaa61b328f Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
354
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
355
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
356 Translation
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
357 ===========
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
358
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
359 If you have prepared MO files for use with Genshi using the appropriate tools,
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
360 you can access the message catalogs with the `gettext Python module`_. You'll
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
361 probably want to create a ``gettext.GNUTranslations`` instance, and make the
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
362 translation functions it provides available to your templates by putting them
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
363 in the template context.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
364
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
365 The ``Translator`` filter needs to be added to the filters of the template
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
366 (applying it as a stream filter will likely not have the desired effect).
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
367 Furthermore it needs to be the first filter in the list, including the internal
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
368 filters that Genshi adds itself:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
369
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
370 .. code-block:: python
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
371
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
372 from genshi.filters import Translator
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
373 from genshi.template import MarkupTemplate
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
374
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
375 template = MarkupTemplate("...")
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
376 template.filters.insert(0, Translator(translations.ugettext))
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
377
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
378 If you're using `TemplateLoader`, you should specify a callback function in
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
379 which you add the filter:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
380
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
381 .. code-block:: python
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
382
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
383 from genshi.filters import Translator
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
384 from genshi.template import TemplateLoader
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
385
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
386 def template_loaded(template):
885
b7e8b971d90a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
387 Translator(translations.ugettext).setup(template)
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
388
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
389 loader = TemplateLoader('templates', callback=template_loaded)
884
e97cdbf09a18 Improve the template loader docs.
cmlenz
parents: 594
diff changeset
390 template = loader.load('test.html')
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
391
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
392 This approach ensures that the filter is not added everytime the template is
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
393 loaded, and thus being applied multiple times.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
394
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
395
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
396 Related Considerations
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
397 ======================
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
398
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
399 If you intend to produce an application that is fully prepared for an
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
400 international audience, there are a couple of other things to keep in mind:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
401
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
402 -------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
403 Unicode
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
404 -------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
405
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
406 Use ``unicode`` internally, not encoded bytestrings. Only encode/decode where
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
407 data enters or exits the system. This means that your code works with characters
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
408 and not just with bytes, which is an important distinction for example when
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
409 calculating the length of a piece of text. When you need to decode/encode, it's
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
410 probably a good idea to use UTF-8.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
411
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
412 -------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
413 Date and Time
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
414 -------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
415
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
416 If your application uses datetime information that should be displayed to users
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
417 in different timezones, you should try to work with UTC (universal time)
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
418 internally. Do the conversion from and to "local time" when the data enters or
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
419 exits the system. Make use the Python `datetime`_ module and the third-party
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
420 `pytz`_ package.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
421
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
422 --------------------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
423 Formatting and Locale Data
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
424 --------------------------
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
425
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
426 Make sure you check out the functionality provided by the `Babel`_ project for
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
427 things like number and date formatting, locale display strings, etc.
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
428
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
429 .. _`datetime`: http://docs.python.org/lib/module-datetime.html
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
430 .. _`pytz`: http://pytz.sourceforge.net/
Copyright (C) 2012-2017 Edgewall Software