view 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
line wrap: on
line source

First of all, thank you for helping translating SàT :)

NOTE: *.po files are in i18n directory

To translate a file, you can use a dedicated tool as the excellent gtranslator:

- 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:
> xgettext -L python -d sat --keyword=D_ -p i18n  **/*(.py|.tac|primitivus)(.) **/jp(.)

- then to start a new translation, copy i18n/sat.pot to your language file, e.g. cd i18n; cp sat.pot fr.po

- use the choosed tool (a simple text editor can be sufficient) to edit the file: e.g. gtranslator fr.po

- 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:
> msgfmt -o sat.mo fr.po
> mv sat.mo i18n/fr/LC_MESSAGES/sat.mo

- 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:
> msgmerge fr.po sat.pot > fr2.po
and if everything is allright
> mv fr2.po fr.po

Don't forget that you can (and should !) use the version-control system (mercurial, the "hg" command) to keep history of you translations.

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.

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).