Changes between Version 23 and Version 24 of CookBook/PluginL10N

Timestamp:

Sep 25, 2012, 11:03:12 PM (12 years ago)

Author:

Christian Boos

Comment:

document #9666 a bit

CookBook/PluginL10N

@@ -196 +196 @@
 }}}
 
-
+Note: Trac 1.0 added support for a special kind of `N_` marker, `cleandoc_`, which can be used to reformat multiline messages in a compact form. There's also support to apply this "cleandoc" transformation to the documentation of instances of `trac.config.Option` and its subclasses. However, this support is coming from a special Python extractor which has to be used instead of the default Python extractor from Babel.
+
+The additional change is:
+{{{#!diff
+Index: setup.py
+===================================================================
+--- setup.py    (revision 11363)
++++ setup.py    (working copy)
+@@ -24,7 +24,7 @@
+     if cmdclass:
+         extra['cmdclass'] = cmdclass
+         extractors = [
+-            ('**.py',                'python', None),
++            ('**.py',                'trac.dist:extract_python', None),
+             ('**/templates/**.html', 'genshi', None)
+         ]
+         extra['message_extractors'] = {
+
+}}}
+
+The default `cleanup_keywords` (the `Option` subclasses) are not automatically `keywords` however. The corresponding option for the `extract_messages` section of the `setup.cfg` file should therefore contain the `cleandoc_` token, or the various `Config` subclasses together with the position of the doc argument in that subclass.
+As a (somewhat complex) example, see the following excerpt from Trac's [source:tags/trac-1.0/setup.cfg setup.cfg] file:
+{{{#!python
+[extract_messages_tracini]
+add_comments = TRANSLATOR:
+copyright_holder = Edgewall Software
+msgid_bugs_address = trac-dev@googlegroups.com
+output_file = trac/locale/tracini.pot
+keywords = ConfigSection:2 Option:4 BoolOption:4 IntOption:4 FloatOption:4 ListOption:6 ChoiceOption:4 PathOption:4 ExtensionOption:5 OrderedExtensionsOption:6
+no-default-keywords = yes
+mapping_file = tracini.cfg
+}}}
 
 ==== Text extraction from Javascript code ==== #Javascript