Skip to content

Translations

Jump to bottom
Alice edited this page May 25, 2021 · 2 revisions

We welcome additional translations for messages sent to members. Please note we are not currently translating admin messages until reaching a stable version of imok, as this also requires a significant review of Django's available translations. This means that the admin interface is in English only at present.

You can submit translations directly in your browser using POEditor.

Fuzzy translations tend to be ignored, so don't mark your translations as fuzzy or incomplete if you are happy with them.

We will periodically add new translations to the project. If this isn't fast enough for you, read on for how to do this yourself.

Language Coverage
English POEditor
Arabic POEditor
French POEditor
German POEditor
Spanish POEditor

How to add new translations

Adding additional languages for the first time requires a number of steps. If you are unable to follow these steps then feel free to raise a GitHub issue requesting the new language, or join our Discord server. The documentation below describes how you would add a Welsh translation (language code cy_GB) as an example.

  1. Run django-admin makemessages -l cy_GB --ignore venv to create the folder structure and put a PO folder in the right place.
  2. You can then either use POEditor, or edit this file manually
    1. POEditor: add or edit the language you want, then download the language file using the 'Export' button. Replace the django.po file in the imok repository with the file you downloaded.
    2. Manually: edit the locale/cy_GB/LC_MESSAGES/django.po file directly. There are a number of free tools to do this with such as poedit.
  3. Run docker-compose run web python manage.py compilemessages to compile the translation file.
  4. Edit imok/settings.py and add ('cy-gb', 'Welsh') to LANGUAGES
  5. Edit application/models.py and add ('cy_GB', 'Welsh') to LANGUAGES
  6. Run docker-compose run web python manage.py makemigrations to list Welsh as an option in the admin screen
  7. Run docker-compose run web python manage.py migrate to apply the migration created above
  8. Raise a pull request for this new language, and request it be added to POEditor if it hasn't already

You should now be able to select Welsh as an option in the admin panel.

After this is done once, we will link the language in POEditor to update automatically.

How to improve existing translations

You can provide improved translations through POEditor and then either raise a GitHub issue requesting it be imported or raise a pull request yourself:

  1. Submit the changes via POEditor
  2. Export the language as a PO file
  3. Copy this PO file over the top of the appropriate file in the repository
  4. Run docker-compose run web python manage.py compilemessages to compile the translation file
  5. Raise a pull request

How to update the reference translation when imok is updated

When new strings are added or edited to the base project, the base (English) translation file needs to be updates.

  1. django-admin makemessages -l en_GB --ignore venv --no-obsolete to update the reference translation
  2. Import the generated locale/en_GB/LC_MESSAGES/django.po file into POEditor
  3. Update the English translation in POEditor and export back to locale/en_GB/LC_MESSAGES/django.po
  4. Run docker-compose run web python manage.py compilemessages to compile the translation file
  5. Raise a pull request with this new string, and (optionally) notify translators that there are new strings to translate
Clone this wiki locally