annotate README4TRANSLATORS @ 771:bfabeedbf32e

core: i18n refactoring: - _() is no more installed in __builtin__ - instead, there is a new sat.core.i18n module - added D_() method for deferred translation - languageSwitch method allow to dynamically change translation language - import gettext is tested against ImportError, and dummy methods are used when not available (mainly useful for Libervia)
author Goffi <goffi@goffi.org>
date Sun, 29 Dec 2013 17:06:01 +0100
parents 86d249b6d9b7
children 519e7f79729b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 First of all, thank you for helping translating SàT :)
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2
223
86d249b6d9b7 Files reorganisation
Goffi <goffi@goffi.org>
parents: 69
diff changeset
3 NOTE: *.po files are in i18n directory
86d249b6d9b7 Files reorganisation
Goffi <goffi@goffi.org>
parents: 69
diff changeset
4
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
5 To translate a file, you can use a dedicated tool as the excellent gtranslator:
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
6
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
7 - use the template .po file (e.g. sat.po) and name it to your translated language (e.g. fr.po for french); you can preferably generate a new template directly from the source with the following command (eventually adapted, the following command use zsh's globbing syntax), launched from root sat dir:
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
8 > xgettext -L python -d sat --keyword=D_ -p i18n **/*(.py|.tac|primitivus|wix|jp)(.)
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
9
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
10 - then to start a new translation, copy i18n/sat.po to your language file, e.g. cd i18n; cp sat.po fr.po
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12 - use the choosed tool (a simple text editor can be sufficient) to edit the file: e.g. gtranslator fr.po
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14 - once you translation is finished (or partly finished: the english sentences are used if there is no translation), you can test them by generating a binary and moving it to the right place with the following commands:
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15 > msgfmt -o sat.mo fr
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16 > mv sat.mo i18n/fr/LC_MESSAGES/sat.mo
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18 /!\ Note that you don't need to precise the file extention mith the msgfmt command, here fr mean "use fr.po file"
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 - if you have already a translation, and want to update it (new translations to do, some sentences have changed), you can use the following commands:
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 > msgmerge fr.po sat.po > fr2.po
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22 and if everything is allright
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
23 > mv fr2.po fr.po
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
25 Don't forget that you can (and should !) use the version-control system (mercurial, the "hg" command) to keep history of you translations.
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27 You can check the fr.po file to see how it's done and to know what to put while you set up you translation tool.
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
29 Trank you again for you help, don't forget to give me your name and contact email so I can credit you, and don't hesitate to contact me if you need help (goffi@goffi.org, or the sat XMPP room at sat@chat.jabberfr.org).
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30