Changes between Version 15 and Version 16 of CookBook/PluginL10N

Timestamp:

May 20, 2010, 12:57:11 AM (14 years ago)

Author:

hasienda <hoff.st@…>

Comment:

add information regarding msg text extraction from Genshi templates and Java scripts

CookBook/PluginL10N

@@ -133 +133 @@
 This is a somewhat time consuming task depending on the size of the plugin's code. If you initially fail to find all desired texts you may notice this by missing them from the message catalog later and come back to this step again. If the plugin maintainer is unaware of your i18n work or unwilling to support it and he adds more message without the translation function call, remember that you have to do the wrapping of these new texts too.
 
+==== Text extraction from Genshi templates ====
 Message extraction for Genshi templates should be done auto-magically. However there is the markup `i18n:msg` available to ensure extraction even from less common tags. For a real-world example have a look at [changeset:9542/trunk/trac/ticket/templates/ Trac SVN changeset r9542] for marking previously undetected text in templates. But there are not all issues settled with some special cases for message extraction from Genshi templates, i.e. see [g:ticket:385 Genshi ticket 385]. You should search for similar issues you may encounter while trying to handle plugin templates.
 
-[FIXME: add more details about msg extraction from other files]
+But Babel only does extract from Python scripts by default. To extract messages from Genshi templates as well, you'll have to declare the needed extractors in `setup.py`:
+{{{#!diff
+diff --git a/setup.py b/setup.py
+--- a/setup.py
++++ b/setup.py
+@@ -34,6 +35,21 @@
+
+ from setuptools import find_packages, setup
+
++extra = {}
++try:
++    extractors = [
++        ('**.py',                'python', None),
++        ('**/templates/**.html', 'genshi', None),
++        ('**/templates/**.txt',  'genshi', {
++            'template_class': 'genshi.template:TextTemplate'
++        }),
++    ]
++    extra['message_extractors'] = {
++        'foo': extractors,
++    }
++except ImportError:
++    pass
++
+ setup(
+     name = 'foo',
+     version = '0.12',
+@@ -53,6 +69,7 @@
+             'templates/*.txt',
+             'htdocs/*.*',
+             'htdocs/css/*.*',
++            'locale/*/LC_MESSAGES/*.mo',
+         ]
+     },
+     install_requires = [
+@@ -96,4 +113,5 @@
+         ]
+     },
+     test_suite = '<path>.tests',
++    **extra
+ )
+}}}
+
+==== i18n for Java scripts ====
+{{{#!comment
+This is taken largely from studying code in http://trac-hacks.org/wiki/TracTicketTemplatePlugin. Some conclusions may be plain wrong, since I had not time to carefully investigate and verify this. 
+}}}
+Note: This section has some preliminary content. Please handle with care and contribute your/any better knowledge on the subject.
+
+You'll have to start with marking text to get it handled by translation helper programs, so a line that was
+{{{
+    var answer = confirm("Submit ticket?");
+}}}
+before, will read like
+{{{
+    var answer = confirm("${_('Submit ticket?')}");
+}}}
+afterwards.
+
+Wrap whole code containing marked text with a text replacement function like
+{{{
+$.fn.extend({
+        foo: function() {
+        function _(message){ return message; }
+        messages = [
+            _('Submit ticket?'),
+        ]
+
+        ...
+
+        function onFormSubmit(evt) {
+            if (evt.type == "submit"){
+                // confirm to save
+                if ($("#ticket_status").length == 0 || $.trim($("#ticket_status$
+                    var answer = confirm("${_('Submit ticket?')}");
+                    if (!answer) {
+                        return false;
+                    }
+                }
+            }
+        }
+
+        ...
+
+});
+
+}}}
+
+To extract messages from Java scripts, you'll have to extend  `setup.py` like shown in previous chapter for Genshi templates, but declare yet another extractor by listing it within the `extractors` list:
+{{{
+        ('**/templates/**.js',   'javascript', None),
+}}}
 
 ==== Register message catalog files for packaging ====
-To include the translated messages into the packaged plugin you need to add the path to the catalog files to `package_data` in `setup.py`:
+To include the translated messages into the packaged plugin you need to add the path to the catalog files to `package_data` in the call for function `setup()` in `setup.py`:
 {{{#!diff
 diff -u a/setup.py b/setup.py