From 9265732e57b55a88276de33684c1ecbf40f08743 Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Wed, 31 May 2023 10:59:26 +0100 Subject: [PATCH] Update readme on internationalization --- {{cookiecutter.project_slug}}/locale/README.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.project_slug}}/locale/README.rst b/{{cookiecutter.project_slug}}/locale/README.rst index c2f1dcd6f..4a7533107 100644 --- a/{{cookiecutter.project_slug}}/locale/README.rst +++ b/{{cookiecutter.project_slug}}/locale/README.rst @@ -1,6 +1,17 @@ Translations ============ -Translations will be placed in this folder when running:: +Translations strings will be placed in this folder when running:: - python manage.py makemessages + python manage.py makemessages -all + +This should generate ``django.po`` (stands for Portable Object) files under each locale `/LC_MESSAGES/django.po`. Each translatable string in the codebase is collected with its ``msgid`` and need to be translated as ``msgstr``, for example:: + + msgid "users" + msgstr "utilisateurs" + +Once all translations are done, they need to be compiled into ``.mo`` files (stands for Machine Object), which are the actual binary files used by the application:: + + python manage.py compilemessages + +Note that the ``.po`` files are NOT used by the application directly, so if the ``.mo`` files are out of dates, the content won't appear as translated even if the ``.po`` files are up to date.