Mercurial > libervia-backend
annotate README4TRANSLATORS @ 4212:5f2d496c633f
core: get rid of `pickle`:
Use of `pickle` to serialise data was a technical legacy that was causing trouble to store
in database, to update (if a class was serialised, a change could break update), and to
security (pickle can lead to code execution).
This patch remove all use of Pickle in favour in JSON, notably:
- for caching data, a Pydantic model is now used instead
- for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation
- in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and
`to_dict` method have been implemented to do serialisation.
- new methods to (de)serialise data can now be specified with Identity data types. It is
notably used to (de)serialise `path` of avatars.
A migration script has been created to convert data (for upgrade or downgrade), with
special care for XEP-0373 case. Depending of size of database, this migration script can
be long to run.
rel 443
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 23 Feb 2024 13:31:04 +0100 |
| 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 |