Changes between Version 56 and Version 57 of TracL10N

Timestamp:

May 12, 2008, 10:03:49 AM (16 years ago)

Author:

Christian Boos

Comment:

more detailed informations about setting up the toolchain and working on the translations

TracL10N

@@ -5 +5 @@
 The preference panel for language works now (since r6732).
 
+If you're only interested in using a localized version of Trac, then refer to the simpler ["0.12/TracInstall"] instructions. The more complete installation instructions below are aimed at translators.
+
 == Installation ==
 
- 1. Install [http://babel.edgewall.org/ Babel].
- 1. Get a svn checkout from the [source:trunk trunk], e.g. `svn checkout http://svn.edgewall.org/repos/trac/trunk trac`
- 1. Run `python setup.py compile_catalog`, you might need to use the force option (`-f`): `python setup.py compile_catalog -f` in order to compile catalogs marked fuzzy. If you are interested in just one locale, provide the `-l` option to specify a single locale to be compiled, for example: `-l nl_NL`.
- 1. Run `python setup.py build`
- 1. Run `python setup.py install`
+=== Getting the Tool Chain ===
+ 1. Install [http://babel.edgewall.org/ Babel], trunk version Babel:r364 precisely for now. [[br]]
+    Read the [http://babel.edgewall.org/wiki/SubversionCheckout detailed installation instructions] for Babel. Chances are that once Babel 1.0 has been release, this will be the required version for Trac and the installation will be a simple `easy_install` by then. For now, please ''don't'' do that and use the version explicitly specified above.
+ 1. Likewise, install [http://genshi.edgewall.org/ Genshi], trunk version Genshi:r851.
+ 1. Get a svn checkout from the Trac [source:trunk trunk], e.g. `svn checkout http://svn.edgewall.org/repos/trac/trunk trac-0.12dev`
 
-Note that the last two steps are not required if you're developing Trac and you're running it directly from the checkout.
+=== Translation Workflow ===
+ 1. Run `python setup.py extract_messages`. [[br]] 
+    This will generate the catalog template file: `trac/locale/messages.pot`.
+    You won't need to edit that file manually.
+ 1. Run `python setup.py update_catalog`. [[br]]
+    This will regenerate the various string catalogs (`trac/locale/*_*/LC_MESSAGES/messages.po`),
+    preserving the previously translated strings. [[br]]
+    Usually, you will be interested in just one locale, so you can provide the `-l` option to specify which catalog should be updated. For example: [[br]]
+    `python setup.py update_catalog -l nl_NL`. [[br]]
+ 1. Now, open your favorite editor and add or modifiy translations for the extracted strings in the catalog for your language. See examples below.
+ 1. Once you're done, you should test your translations: 
+    - Run `python setup.py compile_catalog -f`. [[br]]
+      This will generate one compiled catalog (`message.mo` file) for each (or each specified) source catalog. You don't need to do anything with those files, they'll get installed automatically. [[br]]
+      You will most probably need to use the force option (`-f`) in order to compile catalogs marked "fuzzy". [[br]]
+      You can also use the `-l` option here to specify which specific locale has to be compiled.
+    - Run `python setup.py install` for installing Trac and locale data, or you can use `python setup.py develop` once for all, if you want to be able to run Trac from your working copy.
 
 == Contributing ==
 
-The various locale files can be found in the repository under source:trunk/trac/locale. The `messages.pot` is the template file from which the various locale-specific files get created by an `init_catalog` call to `setup.py` with the `-l` locale flag specifier.
+The various catalog files (`messages.po`) can be found in the repository under source:trunk/trac/locale. The `messages.pot` is the template file from which the various locale-specific files get created.
+If you need to create a catalog for a new locale (e.g. fr_CA), do:
+{{{
+$ ./setup.py init_catalog -l fr_CA
+}}}
 
-For the various languages there are already various tickets logged in which the work on them is tracked.
+'''TODO: add translation examples'''
 
-= The following is historical information =
+For the various languages there are already various tickets logged in which the work on them is tracked:
+[[TicketQuery(keywords~=l10n,milestone=0.12,status!=closed)]]
+
+This is a way by which translators for the same language can coordinate their work.
+Look also at the various term definition pages:
+
+[[TitleIndex(TracTerms)]]
+
+Open issues:
+ - [[TicketQuery(keywords~=i18n,milestone=0.12,status!=closed)]]
+ - i18n infrastructure for Trac plugins
+
+----
+== The following is historical information ==
 
 === Wiki ===