Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.53 KB

_TRANSLATION.md

File metadata and controls

67 lines (49 loc) · 2.53 KB
Raw

Translation requires you have Babel installed, and the pybabel command available to run.

Marking strings for translation

In Python files, you can mark a string for translation on the web frontend using flask_babel.

# At the top of the file
import flask_babel
_ = flask_babel.gettext

# At use site, include a tagged comment which will be included for the
# translator, as well as call the `_` function to translate the string.
# MSG: Message shown after logging in as admin successfully
flash(_("Admin mode granted!"), "is-success")

In html Jinja templates, you can either use the _ function, or the {% trans %} tag. You still want to tag the comment with the same MSG: tag so that the translators have context when translating.

{# MSG: Header showing the currently playing song. #}
{% trans %}Now Playing{% endtrans %}


<script>
    // Note the Jinja comment is included in a javascript comment just to stop the syntax
    // highlighter from becoming confused.  All that's required is the jinja comment on the line
    // before the translated string.
    // {# MSG: Confirmation message when clicking a button to skip a track. #}
    `{{ _("Are you sure you want to skip this track? If you didn't add this song, ask permission first!") }}`
</script>

Rebuilding translations

After modifying the templates or code and marking new strings for translation, run

$ pybabel extract -F babel.cfg -o messages.pot --add-comments="MSG:" --strip-comment-tags  --sort-by-file .
$ pybabel update -i messages.pot -d translations
# Update any translations/**/messages.po files
$ pybabel compile -d translations/

This will extract the strings out of the .py and .html files, and place them into the master strings file messages.pot. The update command will update each languages translations/<lang>/LC_MESSAGES/messages.po file, which is what a translator for a particular language will see. The python app consumes messages.mo files, which are binary files created by the compile step.

In order to start translating a new language, use

$ pybabel init -i messages.pot -d translations -l $NEW_LOCALE

to create a new empty .po file. As well as editing the constants.py LANGUAGES mapping to make that language available.

How are translations detected

Currently I have it set based on the Accept-Language header sent with each request, which can be modified using this guide.