Mercurial > genshi > genshi-test

annotate doc/i18n.txt @ 886:9bd255289d75

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Set reST MIME type on new loader doc page.
author cmlenz
date Fri, 16 Apr 2010 22:44:29 +0000
parents 80f80f2eec6a
children 148c17f49111
rev   line source
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
2
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
3 =====================================
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
4 Internationalization and Localization
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
5 =====================================
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
6
886
9bd255289d75 Set reST MIME type on new loader doc page.
cmlenz
parents: 885
diff changeset
7 Genshi provides comprehensive supporting infrastructure for internationalizing
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
8 and localizing templates. That includes functionality for extracting
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
9 localizable strings from templates, as well as a template filter that can
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
10 apply translations to templates as they get rendered.
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
11
f38ce008ab0a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
13 module`_. The extraction process can be used from the API level, or through
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
14 the front-ends implemented by the `Babel`_ project, for which Genshi provides
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
15 a plugin.
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
16
f38ce008ab0a 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/
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
19 .. _`babel`: http://babel.edgewall.org/
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
20
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
21
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
22 .. contents:: Contents
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
23 :depth: 2
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
24 .. sectnum::
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
25
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
26
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
27 Basics
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
28 ======
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
29
f38ce008ab0a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
31 all localizable strings in a ``gettext()`` function call (which is often
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
32 aliased to ``_()`` for brevity). In that case, no extra template filter is
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
33 required.
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
34
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
35 .. code-block:: genshi
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
36
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
37 <p>${_("Hello, world!")}</p>
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
38
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
39 However, this approach results in significant “character noise” in templates,
528
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
41
f38ce008ab0a 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
f38ce008ab0a 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:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
44
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
45 .. code-block:: genshi
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
46
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
47 <p>Hello, world!</p>
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
48
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
50 ``_()`` call.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
51
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
52 .. note:: For parameterized or pluralizable messages, you need to use the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
53 special `template directives`_ described below, or use the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
54 corresponding ``gettext`` function in embedded Python expressions.
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
55
885
80f80f2eec6a 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
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
59 by default.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
60
f38ce008ab0a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
62 consider the attributes ``abbr``, ``alt``, ``label``, ``prompt``, ``standby``,
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
63 ``summary``, and ``title``, which is a list that makes sense for HTML
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
65 attribute names, or none at all.
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
66
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
67 ----------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
68 Language Tagging
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
69 ----------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
70
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
71 You can control automatic translation in your templates using the ``xml:lang``
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
73 attributes of the element will be ignored:
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
74
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
75 .. code-block:: genshi
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
76
f38ce008ab0a 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>
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
78
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
81 automatic translation:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
82
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
83 .. code-block:: genshi
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
84
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
85 <html xml:lang="$locale">
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
86 ...
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
87 </html>
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
88
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
89
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
90 .. _`template directives`:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
91
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
92 Template Directives
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
93 ===================
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
94
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
95 Sometimes localizable strings in templates may contain dynamic parameters, or
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
97 plural form. Sometimes the strings contain embedded markup, such as tags for
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
99 translations to know the syntax and escaping rules of HTML and XML.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
100
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
101 In those cases the simple text extraction and translation process described
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
102 above is not sufficient. You could just use ``gettext`` API functions in
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
103 embedded Python expressions for parameters and pluralization, but Genshi also
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
104 provides special template directives for internationalization that attempt to
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
105 provide a comprehensive solution for this problem space.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
106
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
107 To enable these directives, you'll need to register them with the templates
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
109 ``Template.add_directives(namespace, factory)`` (where ``namespace`` would be
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
110 “http://genshi.edgewall.org/i18n” and ``factory`` would be an instance of the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
111 ``Translator`` class). Or you can just call the ``Translator.setup(template)``
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
112 class method, which both registers the directives and adds the translation
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
113 filter.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
114
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
115 .. note:: The internationalization directives are still somewhat experimental
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
116 and have some known issues. However, the attribute language they
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
117 implement should be stable and is not subject to change
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
118 substantially in future versions.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
119
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
120
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
121 --------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
122 Messages
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
123 --------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
124
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
125 ``i18n:msg``
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
126 ------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
127
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
128 This is the basic directive for defining localizable text passages that
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
129 contain parameters and/or markup.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
130
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
131 For example, consider the following template snippet:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
132
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
133 .. code-block:: genshi
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
134
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
135 <p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
136 Please visit <a href="${site.url}">${site.name}</a> for help.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
137 </p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
138
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
139 Without further annotation, the translation filter would treat this sentence
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
140 as two separate messages (“Please click” and “here”), and the translator would
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
141 have no control over the position of the link in the sentence.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
142
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
143 However, when you use the Genshi internationalization directives, you simply
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
144 add an ``i18n:msg`` attribute to the enclosing ``<p>`` element:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
145
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
146 .. code-block:: genshi
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
147
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
148 <p i18n:msg="name">
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
149 Please visit <a href="${site.url}">${site.name}</a> for help.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
150 </p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
151
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
153 message for translation purposes. You'll see the following string in your
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
154 message catalog::
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
155
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
156 Please visit [1:%(name)s] for help.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
157
80f80f2eec6a 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
80f80f2eec6a 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.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
160
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
162 names, which serve as simplified aliases for the actual Python expressions the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
163 message contains. The order of the paramer names in the list must correspond
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
165 one parameter: its alias for translation is “name”, while the corresponding
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
166 expression is ``${site.name}``.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
167
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
168 The translator now has complete control over the structure of the sentence. He
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
170 removed, and that the ``name`` parameter is preserved correctly. But those are
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
171 things that can be easily checked by validating the message catalogs. The
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
172 important thing is that the translator can change the sentence structure, and
80f80f2eec6a 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.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
174
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
175 So if the German translator of this snippet decided to translate it to::
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
176
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
177 Um Hilfe zu erhalten, besuchen Sie bitte [1:%(name)s]
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
178
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
179 The resulting output might be:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
180
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
181 .. code-block:: html
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
182
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
183 <p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
184 Um Hilfe zu erhalten, besuchen Sie bitte
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
185 <a href="http://example.com/">Example</a>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
186 </p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
187
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
188 Please note that messages may contain multiple tags, and they may also be
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
189 nested. For example:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
190
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
191 .. code-block:: genshi
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
192
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
193 <p i18n:msg="name">
80f80f2eec6a 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>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
195 for help.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
196 </p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
197
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
198 This would result in the following message ID::
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
199
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
200 [1:Please] visit [2:the site [3:%(name)s]] for help.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
201
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
202 Again, the translator has full control over the structure of the sentence. So
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
203 the German translation could actually look like this::
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
204
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
205 Um Hilfe zu erhalten besuchen Sie [1:bitte]
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
206 [3:%(name)s], [2:das ist eine Web-Site]
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
207
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
208 Which Genshi would recompose into the following outout:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
209
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
210 .. code-block:: html
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
211
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
212 <p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
213 Um Hilfe zu erhalten besuchen Sie <i>bitte</i>
80f80f2eec6a 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>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
215 </p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
216
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
218 tags.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
219
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
220 .. warning:: Please note that ``i18n:msg`` directives do not support other
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
221 nested directives. Directives commonly change the structure of
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
222 the generated markup dynamically, which often would result in the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
223 structure of the text changing, thus making translation as a
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
224 single message ineffective.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
225
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
226 ``i18n:comment``
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
227 ----------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
228
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
229 The ``i18n:comment`` directive can be used to supply a comment for the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
230 translator. For example, if a template snippet is not easily understood
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
231 outside of its context, you can add a translator comment to help the
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
232 translator understand in what context the message will be used:
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
233
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
234 .. code-block:: genshi
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
235
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
236 <p i18n:msg="name" i18n:comment="Link to the relevant support site">
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
237 Please visit <a href="${site.url}">${site.name}</a> help.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
238 </p>
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
239
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
240 This comment will be extracted together with the message itself, and will
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
242 easily visible to the person doing the translation.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
243
80f80f2eec6a 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
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
245 outside of the extraction process.
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
246
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
247
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
248 -------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
249 Pluralization
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
250 -------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
251
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
252 ``i18n:choose``, ``i18n:singular``, ``i18n:plural``
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
253 ---------------------------------------------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
254
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
255 TODO
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
256
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
257 -------------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
258 Translation Domains
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
259 -------------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
260
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
261 ``i18n:domain``
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
262 ---------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
263
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
264 TODO
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
265
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
266 Extraction
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
267 ==========
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
268
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a 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,
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
274
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
275 -----------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
276 Babel Integration
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
277 -----------------
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
278
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
279 This functionality is integrated with the message extraction framework provided
528
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
282 `Distutils`_.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
283
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
286
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a 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,
f38ce008ab0a 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``.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
291
f38ce008ab0a 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:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
293
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
294 .. code-block:: ini
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
295
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
296 # Python souce
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
297 [python:**.py]
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
298
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
299 # Genshi templates
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
300 [genshi:**/templates/**.html]
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
301 include_attrs = title
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
302
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
303 [genshi:**/templates/**.txt]
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
304 template_class = genshi.template.TextTemplate
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
305 encoding = latin-1
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
306
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
308
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
311
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
312
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
313 ---------------------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
314 Configuration Options
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
315 ---------------------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
316
f38ce008ab0a 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:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
318
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
319 ``template_class``
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
320 ------------------
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
323
f38ce008ab0a 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
f38ce008ab0a 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`_.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
326
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
327 .. _`text templates`: text-templates.html
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
328
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
329 ``encoding``
594
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
330 ------------
528
f38ce008ab0a 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
f38ce008ab0a 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”.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
333
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
334 ``include_attrs``
594
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
335 -----------------
528
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
338
594
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
339 ``ignore_tags``
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
340 ---------------
528
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
342 templates.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
343
594
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
344 ``extract_text``
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
345 ----------------
0fb43dc2e165 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.
0fb43dc2e165 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
0fb43dc2e165 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
0fb43dc2e165 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.
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
350
0fb43dc2e165 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
0fb43dc2e165 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
0fb43dc2e165 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.
0fb43dc2e165 Add option to I18n filter to only extract strings in gettext function calls.
cmlenz
parents: 558
diff changeset
354
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
355
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
356 Translation
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
357 ===========
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
358
f38ce008ab0a 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,
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
363 in the template context.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
364
f38ce008ab0a 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
f38ce008ab0a 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).
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
368 filters that Genshi adds itself:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
369
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
370 .. code-block:: python
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
371
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
372 from genshi.filters import Translator
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
373 from genshi.template import MarkupTemplate
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
374
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
375 template = MarkupTemplate("...")
f38ce008ab0a 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))
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
377
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
379 which you add the filter:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
380
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
381 .. code-block:: python
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
382
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
383 from genshi.filters import Translator
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
384 from genshi.template import TemplateLoader
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
385
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
386 def template_loaded(template):
885
80f80f2eec6a Started extending the i18n docs.
cmlenz
parents: 884
diff changeset
387 Translator(translations.ugettext).setup(template)
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
388
f38ce008ab0a 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
5a1c0ee0f659 Improve the template loader docs.
cmlenz
parents: 594
diff changeset
390 template = loader.load('test.html')
528
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
391
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
394
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
395
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
396 Related Considerations
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
397 ======================
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
398
f38ce008ab0a 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
f38ce008ab0a 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:
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
401
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
402 -------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
403 Unicode
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
404 -------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
405
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
411
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
412 -------------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
413 Date and Time
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
414 -------------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
415
f38ce008ab0a 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
f38ce008ab0a 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)
f38ce008ab0a 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
f38ce008ab0a 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
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
420 `pytz`_ package.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
421
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
422 --------------------------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
423 Formatting and Locale Data
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
424 --------------------------
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
425
f38ce008ab0a 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
f38ce008ab0a 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.
f38ce008ab0a Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents:
diff changeset
428
f38ce008ab0a 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
f38ce008ab0a 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