annotate README4TRANSLATORS @ 3922:0ff265725489

plugin XEP-0447: handle attachment and download: - plugin XEP-0447 can now be used in message attachments and to retrieve an attachment - plugin attach: `attachment` being processed is added to `extra` so the handler can inspect it - plugin attach: `size` is added to attachment - plugin download: a whole attachment dict is now used in `download` and `file_download`/`file_download_complete`. `download_uri` can be used as a shortcut when just a URI is used. In addition to URI scheme handler, whole attachment handlers can now be registered with `register_download_handler` - plugin XEP-0363: `file_http_upload` `XEP-0363_upload_size` triggers have been renamed to `XEP-0363_upload_pre_slot` and is now using a dict with arguments, allowing for the size but also the filename to be modified, which is necessary for encryption (filename may be hidden from URL this way). - plugin XEP-0446: fix wrong element name - plugin XEP-0447: source handler can now be registered (`url-data` is registered by default) - plugin XEP-0447: source parsing has been put in a separated `parse_sources_elt` method, as it may be useful to do it independently (notably with XEP-0448) - plugin XEP-0447: parse received message and complete attachments when suitable - plugin XEP-0447: can now be used with message attachments - plugin XEP-0447: can now be used with attachments download - renamed `options` arguments to `extra` for consistency - some style change (progressive move from legacy camelCase to PEP8 snake_case) - some typing rel 379
author Goffi <goffi@goffi.org>
date Thu, 06 Oct 2022 16:02:05 +0200
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