Changes between Version 4 and Version 5 of CookBook/PluginL10N

Timestamp:

May 8, 2010, 3:39:13 PM (14 years ago)

Author:

hasienda <hoff.st@…>

Comment:

added more content going towards desired amount of information

CookBook/PluginL10N

@@ -1 @@
-= Adding l10n support to Trac plugins (Trac >= 0.12) =
+= Adding i18n/l10n to Trac plugins (Trac >= 0.12) =
 == Motivation ==
 [FIXME: content needed, especially address the intended audience (plugin maintainers and developers in general) here - who should read on (and who shouldn't care at all)]
 
-== i18n vs. l10n (again) ==
-[FIXME: is this needed?, well consider this is nice to the reader allowing to focus on i18n after coming from the greater scope of l10n, but be as short as possible when]
+== i18n, l10n, ... help! ==
+For professionals: please skip this, since there can't be any news for you.
 
+In short '''i18n''' stands for '''`i`'''`nternationalizatio`'''`n`''' (count 18 more chars between i and n) and is defined as software design for programs with translation support. '''`l`'''`ocalisatio`'''`n`''' that is abbreviated as '''l10n''' could be seen as a follow-up process providing data for one or more locales. It is taking care of feature differences between the original/default (that is English is most cases including Trac) and a given locale as well. Such features are i.e. sentence structure including punctuation and formatting of numbers, date/time strings, and currencies. Once you did some ground work at the source (i18n), most remaining is proper translation work (l10n) putting more or less effort in preserving the sense of the original while looking as native locale as possible.^1^
 
-== Background and basics of i18n support ==
-The evolution of native support for Trac plugins is documented in [comment:11:ticket:7497 ticket 7497]. The final implementation as documented there in [comment:12:ticket:7497 comment 12] was introduced to Trac trunk in [changeset: changeset r7705] and finally done with [changeset: changeset r7714]. Adding the needed i18n helper functions is as easy as adding
+'''NLS''' (National Language Support or Native Language Support) is meant to be the sum of both. And there are more related terms that we could safely skip for now.^1, 2^
+
+== Background and basics of i18n/l10n support for plugin ==
+The evolution of native i18n/l10n support for Trac plugins is documented in [comment:11:ticket:7497 ticket 7497]. The final implementation as documented there in [comment:12:ticket:7497 comment 12] was introduced to Trac trunk in [changeset: changeset r7705] and finally done with [changeset: changeset r7714]. Adding the needed i18n/l10n helper functions is as easy as adding
 {{{
 from trac.util.translation import domain_functions
@@ -15 +18 @@
     '_', 'tag_', 'N_', 'add_domain')
 }}}
-at the beginning of the main python script file of an existing or new plugin. To bring in the compiled message catalog for actually using the translated texts one will have to extend the `__init__` function of plugins main class too. For a fictional plugin Foo this would be done like this:
+at the beginning of the main python script file of an existing or new plugin. To bring in the compiled message catalog for actually using the translated texts one will have to extend the `__init__` function of plugins main class too. For a fictional plugin 'foo' this would be done like this:
 {{{
     def __init__(self):
@@ -24 +27 @@
         add_domain(self.env.path, locale_dir)
 }}}
-assuming that folder `locale` will reside in `./foo/locale/` within the directory structure (of the Python egg). If you didn't have it, add a `import pkg_resources` to the beginning of the plugin script as well or the line `locale_dir = ...` will throw an '!ImportError'.
+assuming that folder `locale` will reside in `./foo/locale/` within the directory structure (of the Python egg). If you didn't have it in the source by now, add a `import pkg_resources` to the beginning of the plugin script as well or the line `locale_dir = ...` will throw an '!ImportError'.
 
 [FIXME: explain what _version and ui are used for or leave them out, if unnecessary here]
@@ -102 +105 @@
 
 === Advanced stuff ===
-==== Finally l10n ====
+==== Finally 'true' l10n ====
 
 == Related resources ==
+
+^1^ http://en.wikipedia.org/wiki/Internationalization_and_localization - Internationalization and localization[[BR]]
+^2^ http://en.wikipedia.org/w/index.php?title=Multilingualism&section=18 - Multilingualism in computing