Changes between Version 11 and Version 12 of CookBook/PluginL10N

Timestamp:

May 9, 2010, 7:18:57 PM (14 years ago)

Author:

Christian Boos

Comment:

#Summingitup added link to example + talk about setup tool changes r9638

CookBook/PluginL10N

@@ -136 +136 @@
 ==== 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`:
-{{{
-diff -u a/foo/setup.py b/foo/setup.py
---- a/foo/setup.py
-+++ b/foo/setup.py
-@@ -39,6 +39,8 @@
+{{{#!diff
+diff -u a/setup.py b/setup.py
+--- a/setup.py
++++ b/setup.py
+@@ -39,6 +39,7 @@
      package_data = {
-         'foo': [
+         <path>: [
              'htdocs/css/*.css',
-+            'locale/*.*',
-+            'locale/*/LC_MESSAGES/*.*',
++            'locale/*/LC_MESSAGES/*.mo',
          ],
      },
@@ -160 +159 @@
 
 All the work you did by now will go unnoticed, at least with regard to package naming. To help with identification of the new revision you should bump the plugin's version. This is done by changing the version/revision, typically in `setup.cfg` or `setup.py`. And you may wish to leave a note regarding your i18n work along the copyright notices as well.
+
+==== Summing it up ====
+
+Here's an example of the changes required to add i18n support to a plugin: [http://github.com/cboos/trachacks-hudsontracplugin/commit/1669cefa806614e62bd9ce5573750e30fa060408 HudsonTrac 0.12 branch].
+
+Note:
+ - it uses the old style for the `domain_functions` call. While this is still supported, new code should use the new style shown above, `domain_functions(domain, functions)`
+ - it uses: `<path>/locale/*.*, <path>/locale/*/LC_MESSAGES/*.*` for the `package_data`. You should rather use only `<path>/locale/*/LC_MESSAGES/*.*` (see r9638 and r9640)
 
 === Do translators work ===