aliens/SemanticScuttle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

make INSTALL.txt file valid rST

Browse source
This commit is contained in:
Christian Weiske 2011-05-26 21:21:37 +02:00
parent 2dc582cfbb
commit 47005bb1c6
1 changed files with 24 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
doc/developers/translation.rst
View file

@ -1,40 +1,47 @@
===========================
Translating SemanticScuttle
===========================
SemanticScuttle uses gnu gettext for translation. It does not
rely on the php extension but ships with a pure php implementation,
php-gettext[1].
php-gettext_.
Using gettext from within the code is really easy:
Enclose the string you want to translate in a "T_" function call.
Enclose the string you want to translate in a "``T_``" function call.
For example, to translate::
echo "Vote for";
For example, to translate
> echo "Vote for";
just write
> echo T_("Vote for");
echo T_("Vote for");
.. _php-gettext: https://launchpad.net/php-gettext/
Translation basics
------------------
==================
We keep one base translation file, data/locales/messages.po.
This file is auto-generated via xgettext from all our php source files.
In case you added a new string to the code that needs translation,
update the base translation file by running
> php scripts/update-translation-base.php
update the base translation file by running ::
After that has been done, the changes to the base messages.po file
$ php scripts/update-translation-base.php
After that has been done, the changes to the base ``messages.po`` file
need to be merged into the single language translation files,
for example data/locales/de_DE/LC_MESSAGES/messages.po.
for example ``data/locales/de_DE/LC_MESSAGES/messages.po``.
Updating them from the master file is as easy as running
> php scripts/update-translation.php de_DE
Updating them from the master file is as easy as running::
$ php scripts/update-translation.php de_DE
When the translation is ready, the ``.po`` file needs to be compiled
in a machine-readable ``.mo`` file. Use ::
$ php scripts/compile-translation.php de_DE
When the translation is ready, the .po file needs to be compiled
in a machine-readable .mo file. Use
> php scripts/compile-translation.php de_DE
to achieve that.
[1] https://launchpad.net/php-gettext/