annotate README4TRANSLATORS @ 3104:118d91c932a7

plugin XEP-0384: OMEMO for MUC implementation: - encryption is now allowed for group chats - when an encryption is requested for a MUC, real jids or all occupants are used to encrypt the message - a cache for plain text message sent to MUC is used, because for security reason we can't encrypt message for our own device with OMEMO (that would prevent ratchet and break the prefect forward secrecy). Thus, message sent in MUC are cached for 5 min, and the decrypted version is used when found. We don't send immediately the plain text message to frontends and history because we want to keep the same MUC behaviour as for plain text, and receiving a message means that it was received and sent back by MUC service - <origin-id> is used to identify messages sent by our device - a feedback_jid is now use to use correct entity for feedback message in case of problem: with a room we have to send feedback message to the room and not the the emitter - encryptMessage now only accepts list in the renamed "entity_bare_jids" argument
author Goffi <goffi@goffi.org>
date Mon, 30 Dec 2019 20:59:46 +0100
parents 5e72efd2f95d
children
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
2954
5e72efd2f95d doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents: 1291
diff changeset
7 - use the template .pot file (e.g. sat.pot) 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 after having emptied the build directory:
1291
0db0013c59dd remove remaining references to Wix
souliane <souliane@mailoo.org>
parents: 862
diff changeset
8 > xgettext -L python -d sat --keyword=D_ -p i18n **/*(.py|.tac|primitivus)(.) **/jp(.)
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
9
2954
5e72efd2f95d doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents: 1291
diff changeset
10 - then to start a new translation, copy i18n/sat.pot to your language file, e.g. cd i18n; cp sat.pot 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:
862
ca7a2bf4fb40 i18n: updated the translation files
souliane <souliane@mailoo.org>
parents: 845
diff changeset
15 > msgfmt -o sat.mo fr.po
69
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 - 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:
2954
5e72efd2f95d doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents: 1291
diff changeset
19 > msgmerge fr.po sat.pot > fr2.po
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 and if everything is allright
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 > mv fr2.po fr.po
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 223
diff changeset
23 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
24
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 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
26
862
ca7a2bf4fb40 i18n: updated the translation files
souliane <souliane@mailoo.org>
parents: 845
diff changeset
27 Thank 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
28