Skip to content

contributing-translation.md

Latest commit

 

History

History
52 lines (34 loc) · 3.43 KB

contributing-translation.md

File metadata and controls

52 lines (34 loc) · 3.43 KB

Contributions to the localization

Translators

The Tasking Manager is localised using our Transifex repository. This is super easy. If you are interested, make yourself an account and apply to join the hotosm-translator team. Everybody is welcome to support translations through the Transifex website.

Developers

For developers, Transifex offers a CLI client and the Tasking Manager offers commands to interact with it. The client is already included in requirements.txt so you should have the Transifex commands installed once you have set up your backend side code.

The Tasking Manager is using Angular Translate to display the translated strings. It works with key/value pairs in .json format, which is also the format used to store the translations in Transifex.

Setting up Transifex locally

To set up the Transifex client, you'll need a Transifex account and API key. In the project's top level directory, initialize Transifex service: tx init. The init process will ask for service URL (leave the default suggestion by hitting enter) and your Transifex username/password.

The .tx folder contains the Transifex config file. This is where you can find the mappings to local translation files.

Update translation strings

  • yarn build-locales - Execute that command in the frontend folder to get the new translatable strings from all the messages.js files in the frontend code. The changes in the strings will be pushed to frontend/src/locales/en.json file. The ideal is to execute that command before every pull request that change something in the translatable strings.
  • After the pull request is merged to the develop branch, the command tx push -s needs to be executed in order to push the changes to Transifex. The translators receive a notification every time we push changes to Transifex.

Update with latest translations

  • Before a release, new translations need to be pulled in: tx pull -af --mode translator - Gets all translations from Transifex and puts them into frontend/src/locales/.
  • The Transifex dashboard can be used to check the status of the translations. If a language is not enabled in the .tx/config file, the translation updates will be downloaded to the .tx/tasking-manager.version-4/ folder.

Adding a new language

The steps required to add a new language support to Tasking Manager are the following:

  • Add the language support using the Transifex dashboard;
  • Edit .tx/config and add a line like: trans.ml = frontend/src/locales/ml.json
  • Add the new language and language code to:
    • The SUPPORTED_LANGUAGES dictionary in the config file backend/config.py;
    • The supportedLocales array on frontend/src/utils/internationalization.js;
    • The polyfills in frontend/src/utils/polyfill.js;
    • If the new language is not yet supported by iso-countries-languages, we need to update it and publish a new version.

Pushing translations

You can also translate locally and push the Use Transifex's tx push -s to push local changes to Transifex.

  • Argument -s pushes source files (English in our case)
  • Argument -t pushes all translation files