Changes between Version 124 and Version 125 of TracL10N

Timestamp:

Oct 28, 2012, 6:00:49 PM (11 years ago)

Author:

Christian Boos

Comment:

reviewing the page, a lot of minor updates

TracL10N

@@ -2 +2 @@
 = Localization (L10N) of Trac =
 
-Trac uses [http://babel.edgewall.org/ Babel] for localization. Starting with version [milestone:0.12], Trac contains the i18n framework and L10N files.
-
-The ''Preferences / Language'' panel can be used to select the language from the list of available translations, otherwise the web browsers' language preferences will be honored, if possible.
+Trac uses [http://babel.edgewall.org/ Babel] for localization. Starting with version [milestone:0.12], Trac contains the i18n framework and L10N message catalog files.
+
+From the user point of view, the ''Preferences / Language'' panel can be used to select the language from the list of available translations, otherwise the web browsers' language preferences will be honored, if possible.
 
 If you're only interested in using a localized version of Trac, then nothing more than a standard TracInstall is needed, provided you installed Babel before. 
 
-The more complete installation instructions below are aimed at developers and translators, who want to contribute translations for Trac 0.12.x and 1.0dev.
+The more complete installation instructions below are aimed at developers and translators, who want to contribute translations for Trac 0.12.x and beyond.
 
 Note that this whole page is dedicated to the technical details of translating the Trac web application. There's also a parallel effort to translate the TracGuide, see TracGuideTranslations. While there's much more "text" to translate there, there are also much less technical constraints, so if you're intimidated by what follows but nevertheless would like to contribute back to Trac by providing your language expertise, here's a nice alternative!
@@ -16 +16 @@
 === Getting the Tool Chain ===
 ==== Python Tools ==== #Pythontools
- 1. Install [http://babel.edgewall.org/ Babel] version [Babel:wiki:Download#LatestRelease:0.9.5 0.9.5] or newer [[br]]
+ 1. Install [http://babel.edgewall.org/ Babel] version [Babel:wiki:Download#LatestRelease:0.9.6 0.9.6] or newer [[br]]
     Read the [http://babel.edgewall.org/wiki/SubversionCheckout detailed installation instructions] for Babel if you want to build it from source, but you should also be able to install it with a simple `easy_install` or by using one of the packages in the Download page linked above.
  1. Likewise, install [http://genshi.edgewall.org/ Genshi] version [Genshi:wiki:Download#LatestRelease:0.6 0.6], 
     using `easy_install` or by using one of the packages available for download.
- 1. Get a svn checkout from the Trac release line you want to translate: 
-    - [[span(style=color: grey,[source:trunk] for 1.0dev, e.g. `svn checkout http://svn.edgewall.org/repos/trac/trunk trac-1.0dev`)]] (opened for translations)
-    - [source:branches/0.12-stable] for 0.12.x, e.g. `svn checkout http://svn.edgewall.org/repos/trac/trunk trac-0.12.x` (opened for translations)
+ 1. Get a [TracRepositories source code checkout] for the Trac release line you want to translate: 
+    - [source:trunk] for 1.1.x, \\ e.g. `svn checkout http://svn.edgewall.org/repos/trac/trunk trac-1.0dev`
+    - [source:branches/1.0-stable] for 1.0.x, \\ e.g. `svn checkout http://svn.edgewall.org/repos/trac/branches/1.0-stable trac-1.0dev`
+    - [source:branches/0.12-stable] for 0.12.x, \\ e.g. `svn checkout http://svn.edgewall.org/repos/trac/branches/0.12-stable trac-0.12.x`
 
 All the discussion and examples below refer to `trunk`, but everything will work out exactly the same way for the `0.12-stable` branch or any other more recent branch.
@@ -30 +31 @@
 It is very important to not waste time translating an out-of-date catalog.
 
-In the repository, only the catalog **templates** ([source:trunk/trac/locale/messages.pot trac/locale/messages.pot] and [source:trunk/trac/locale/messages-js.pot trac/locale/messages-js.pot]) get updated regularly by Trac developers. If we would do so for the all the `.po` catalogs, this would generate lots of big and noisy changesets. So we leave that task up to the translators, which is something they should do before starting the actual translation work.
+In the repository, only the catalog **templates** ([source:trunk/trac/locale/messages.pot trac/locale/messages.pot] and [source:trunk/trac/locale/messages-js.pot trac/locale/messages-js.pot]) get updated regularly by Trac developers. If we would do so for the all the `.po` catalogs, this would generate lots of big and noisy changesets. So we leave that task up to the translators, which is something they should do before starting the actual translation work or before integrating updates coming from contributors when they're acting as translation team coordinators.
 
 There are several different procedures to get the catalogs in sync with the templates, choose the one you're more comfortable with.
 
 ==== Using Python tools ====
+
  1. Run `python setup.py extract_messages`. [[br]] 
     This will generate the catalog template file:  
@@ -45 +47 @@
  1. Run `python setup.py update_catalog`. [[br]]
     This will regenerate the various string catalogs 
-    (`trac/locale/*_*/LC_MESSAGES/messages.po`),
+    (`trac/locale/*/LC_MESSAGES/messages.po`),
     preserving the previously translated strings and merging the new
     translations found in the messages.pot file. Translations that are
     no longer needed are commented out (`#~`) and moved at the bottom of the 
-    .po file. [[br]]
+    .po file (be careful, they will be discared by the next update, so if 
+    they contain valuable content, save it somewhere). [[br]]
     Usually, you will be interested in working on one locale only, so you
     can pass the `-l` option to specify which catalog should be updated. 
@@ -57 +60 @@
     extracted strings in the messages.po file for your language. 
     [[comment(See examples below.)]]
- 1. Once you're done, you should test your translations: 
+ 1. Once you're done, you should **validate** your translations: 
     1. Run `python setup.py update_catalog -l` again, for normalizing the 
       manual edits. For example: [[br]]
@@ -67 +70 @@
       messages.pot file (as discussed in step 2. above) have been discarded 
       by this second `update_catalog` run.
-    2. Run `python setup.py compile_catalog -f`. [[br]]
+    2. Run `python setup.py check_catalog -f`. [[br]]
+      This will search the catalog for common mistakes, like placeholder 
+      mismatches, invalid embedding in Genshi's structure messages, etc.
+    3. Run `python setup.py compile_catalog -f`. [[br]]
       This will generate one compiled catalog (`message.mo` file) for each
       (or each specified) messages.po file. You don't need to do anything 
@@ -84 +90 @@
       Alternatively you can use `python setup.py develop` once for all, 
       if you want to be able to run Trac from your working copy.
-
-Note that you could stop at step 3, but then you risk to submit incomplete or,
-worse, buggy messages.po files. Going through the 4^th^ step will ensure a
+      Beware that there's no ''on the fly'' compilation of the catalogs,
+      so any change will have to go through step 4.3 (compile) before being
+      visible in your Trac instance.
+
+If you skip the 4th step (validation), you risk to submit incomplete or,
+worse, buggy messages.po files. Going through the 4th step will ensure a
 better quality standard. Finally, seeing your translations "live" in Trac is
 not only a great way to realize if the translation still makes sense once put
@@ -92 +101 @@
 wording ;-)
 
+Note that the above was written at a time there was only //one// catalog file,
+messages.pot. So in order to be complete, you'd have to repeat this for all
+the catalogs:
+ - `messages-js`
+   - `extract_messages_js`
+   - `update_catalog_js`
+   - `check_catalog_js`
+   - `compile_catalog_js`
+   - `generate_messages_js` (the last step specific to Javascript i18n)
+ - `tracini`
+   - `extract_messages_tracini`
+   - `update_catalog_tracini`
+   - `check_catalog_tracini`
+   - `compile_catalog_tracini`
+
+If this look tedious and you're thinking about scripting all of this... don't worry, that has already been done, see [#using-make] below.
+
 ==== Using `msgfmt` tools ====
 
 Although Babel is Python specific and is the tool which is advised to use,
-the traditional [http://linux.die.net/man/1/msgfmt msgfmt] toolset (part of GNU `gettext`) can also be used.
+the traditional [http://linux.die.net/man/1/msgfmt msgfmt] toolset (part of GNU `gettext`) can also be used, but preferably for related tasks like checking the catalogs and getting statistics, rather than updating or the compiling the catalogs.
+
 In particular, the following command is quite useful:
 {{{
@@ -113 +140 @@
 Some errors were detected with format specifications.
 
-This is a useful ''additional'' check, as `python setup.py compile_catalog -l zh_CN` wouldn't have detected that issue.
+This is a useful ''additional'' check, as neither `python setup.py compile_catalog -l zh_CN` nor `python setup.py check_catalog -l zh_CN` wouldn't have detected that issue. FIXME //we detect mismatches, but not missing placeholders in `msgstr`//
 
 
@@ -119 +146 @@
 
 The web-based collaborative site for translations Transifex has
-a [Transifex: project page for Trac].
+a [Transifex: project page for Trac] and its convenient user interface makes it very attractive for translators who don't want to mess directly with the source code.
 
 There, a number of "resources" (`.pot` messages catalog files in our case) are grouped in several "releases". Currently the "releases" corresponds to our maintenance branches.
@@ -136 +163 @@
    - [Transifex:resource/trunk-tracini-pot 1.0-stable - trac/locale/tracini.pot]
 
-There, you can add translations directly online once you're member of a translation team, but in the end, the changes will have to be committed back to the source tree. See [./Transifex] sub page for more details.
-
-
-==== The easy way using `make` and l10n targets ====
+Once you're member of a translation team, you can add translations directly online. But in the end, the changes will have to be committed back to the source tree, so you better have to check beforehand with the translator coordinator of your language to see if is comfortable with getting updates from Transifex. If you are a translation team coordinator, please refer to the [./Transifex] sub page for more details.
+
+
+==== The easy way using `make` and l10n targets ==== #using-make
 
 You'll find a Makefile in the toplevel directory of the Trac source.
@@ -179 +206 @@
 
 Example usage:
-{{{
+{{{#!console
 $ make stats-pot update check compile stats locale='fr de'
 translation statistics for messages.pot:
@@ -227 +254 @@
 Then proceed through the steps listed [#Pythontools above] starting at step 2.
 
+
 === How far would you like to go?
 
@@ -241 +269 @@
 Those statistics reflect the coverage status of the `.po` files (catalogs) compared to the `.pot` files (catalog templates). The template catalogs themselves **might** be out-of-date compared to the source itself, though we regularly perform an automatic extraction.
 
- **0.12-stable** [[Image(http://www.transifex.net/projects/p/trac/resource/0_12-stable-messages-pot/chart/image_png, align=middle, title=go to the Trac page for 0.12-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/0_12-stable/)]]
-
- **1.0-stable** [[Image(http://www.transifex.net/projects/p/trac/resource/1_0-stable-messages-pot/chart/image_png, align=middle, title=go to the Trac page for 1.0-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/1_0-stable/)]]
-
- **trunk** [[Image(http://www.transifex.net/projects/p/trac/resource/trunk-messages-pot/chart/image_png, align=middle, title=go to the Trac page for trunk on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/trunk/)]]
-
-Kindly provided by [[Image(https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png, link=http://www.transifex.net/, title=the open translation platform, valign=bottom)]]
+|| ||= messages.pot ||= messages-js.pot ||= tracini.pot ||
+||= 0.12-stable || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/0_12-stable-messages-pot/chart/image_png, align=middle, title=go to the Trac page for 0.12-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/0_12-stable/)]] || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/0_12-stable-messages-js-pot/chart/image_png, align=middle, title=go to the Trac page for 0.12-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/0_12-stable/)]] || \
+|| ||
+||= 1.0-stable || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/1_0-stable-messages-pot/chart/image_png, align=middle, title=go to the Trac page for 1.0-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/1_0-stable/)]] || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/1_0-stable-messages-js-pot/chart/image_png, align=middle, title=go to the Trac page for 1.0-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/1_0-stable/)]] || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/1_0-stable-tracini-pot/chart/image_png, align=middle, title=go to the Trac page for 1.0-stable on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/1_0-stable/)]] ||
+||= trunk || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/trunk-messages-pot/chart/image_png, align=middle, title=go to the Trac page for trunk on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/trunk/)]] || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/trunk-messages-js-pot/chart/image_png, align=middle, title=go to the Trac page for trunk on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/trunk/)]] || \
+|| [[Image(http://www.transifex.net/projects/p/trac/resource/trunk-tracini-pot/chart/image_png, align=middle, title=go to the Trac page for trunk on Transifex.net, link=https://www.transifex.net/projects/p/trac/r/trunk/)]] ||
+
+
+Charts kindly provided by [[Image(https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png, link=http://www.transifex.net/, title=the open translation platform, valign=bottom)]], based on the content of the catalogs uploaded there, which //should// correspond to the content of the catalogs in the repository.
 
 
@@ -317 +354 @@
 As with message parameters, the groups can be reordered but **you should 
 have the same groups in `msgid` and `msgstr`** (see for example r9553).
+The various `check_catalog_*` commands (`make check`) now look for such errors.
 
 Of course, you can have messages that combine markup groups and 
@@ -377 +415 @@
 === For Committers
 
-If you have commit access to the translation catalogs in the SubversionRepository, then you should be careful to commit only error-less updates. Translations can be fuzzy or missing, that's not a problem, but the errors spotted by `make check compile locale=<yourlocale>` should really be fixed before committing. Please also take care of [n:...] nestings, as those mistakes are **not** detected by the above automated checks and are quite deadly (#9171).
+If you have commit access to the translation catalogs in the SubversionRepository, then you should be careful to commit only error-less updates. Translations can be fuzzy or missing, that's not a problem, but the errors spotted by `make check compile locale=<yourlocale>` should really be fixed before committing. Please also take care of fixing any `[n:...]` nestings errors reported by `make check`, as those mistakes are quite deadly (#9171).
 
 The commit message should have the following format:
 {{{
-l10n/<yourlocale>: <some message> (<xy>%)
+<branch-name>/l10n/<yourlocale>: <some message> (<xy>%)
 
 <additional text if needed>
 }}}
+`<branch-name>` can be omitted for trunk.
+
 The percentage being the ratio of:
 {{{#!table class=""
@@ -405 +445 @@
   title attributes::
    those attributes are collected automatically (i.e. no need for explicit `${_('...')}` expressions), but only when the message doesn't contain an expression. In the latter case, they need an explicit `${_('... %(param)s ...', param=...)}` wrapping
- typographical translation:: some languages, like French, have special typographical rules (non breaking space before ":" or ";"), so don't consider that those signs can be left outside of translation scope when part of the text (e.g. `_(";")` when ";" is used as a separator, `_("%(field)s:")`)
+ typographical translation:: some languages, like French, have special typographical rules (non breaking space before ":" or ";"), so don't consider that those signs can be left outside of translation scope when part of the text (e.g. use `_(";")` when ";" is used as a separator, `_("%(field)s:")` instead of `'%(field)s:'`)
  messages consolidation::
-  when adding new messages, always look if there's not already a very close message, and then reuse it (e.g. we now have 7 occurrences of ''"Repository '%(repo)s' not found"'', previously we had 7 variants of that message)
+  when adding new messages, always look if there's not already a very close message, and then reuse it (e.g. we now have 7 //occurrences// of one single ''"Repository '%(repo)s' not found"'' message, previously we had 7 //messages//, each slightly different from the other!)
  non-translatable messages:: in Genshi templates, you can use `xml:lang="en"` to mark the text in the element as not to be extracted (r10265)
 
@@ -413 +453 @@
 
 === Open Issues === #Openissues
- - ''' help us spot the MissingTranslations! '''
+ - ''' help us spot the MissingTranslations in the source code '''
+ - some terms that should be translated are simply not present in the source code, but rather live in the TracIni or the database... but even for these nasty ones we have a plan: TracDev/Proposals/ConfigEnumTranslation
  - translation of wiki pages (#1513) and help pages (TracDev/Proposals/NewHelp)