Mercurial > libervia-backend
annotate README4TRANSLATORS @ 3254:6cf4bd6972c2
core, frontends: avatar refactoring:
/!\ huge commit
Avatar logic has been reworked around the IDENTITY plugin: plugins able to handle avatar
or other identity related metadata (like nicknames) register to IDENTITY plugin in the
same way as for other features like download/upload. Once registered, IDENTITY plugin will
call them when suitable in order of priority, and handle caching.
Methods to manage those metadata from frontend now use serialised data.
For now `avatar` and `nicknames` are handled:
- `avatar` is now a dict with `path` + metadata like `media_type`, instead of just a string
path
- `nicknames` is now a list of nicknames in order of priority. This list is never empty,
and `nicknames[0]` should be the preferred nickname to use by frontends in most cases.
In addition to contact specified nicknames, user set nickname (the one set in roster) is
used in priority when available.
Among the side changes done with this commit, there are:
- a new `contactGet` bridge method to get roster metadata for a single contact
- SatPresenceProtocol.send returns a Deferred to check when it has actually been sent
- memory's methods to handle entities data now use `client` as first argument
- metadata filter can be specified with `getIdentity`
- `getAvatar` and `setAvatar` are now part of the IDENTITY plugin instead of XEP-0054 (and
there signature has changed)
- `isRoom` and `getBareOrFull` are now part of XEP-0045 plugin
- jp avatar/get command uses `xdg-open` first when available for `--show` flag
- `--no-cache` has been added to jp avatar/get and identity/get
- jp identity/set has been simplified, explicit options (`--nickname` only for now) are
used instead of `--field`. `--field` may come back in the future if necessary for extra
data.
- QuickContactList `SetContact` now handle None as a value, and doesn't use it to delete the
metadata anymore
- improved cache handling for `metadata` and `nicknames` in quick frontend
- new `default` argument in QuickContactList `getCache`
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 14 Apr 2020 21:00:33 +0200 |
parents | 5e72efd2f95d |
children |
rev | line source |
---|---|
69 | 1 First of all, thank you for helping translating SàT :) |
2 | |
223 | 3 NOTE: *.po files are in i18n directory |
4 | |
69 | 5 To translate a file, you can use a dedicated tool as the excellent gtranslator: |
771 | 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 | 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 | 11 |
12 - use the choosed tool (a simple text editor can be sufficient) to edit the file: e.g. gtranslator fr.po | |
13 | |
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 | 16 > mv sat.mo i18n/fr/LC_MESSAGES/sat.mo |
17 | |
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 | 20 and if everything is allright |
21 > mv fr2.po fr.po | |
22 | |
771 | 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 | 24 |
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. | |
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 | 28 |