How to translate django applications?

i18n
translation
manual
retag add tags

What are steps necessary to translate a django program into another language?

What good practices, gotchas, and common issues are there? Please feel free to add.

Here are the detailed instructions at the Django project site.

Note: askbot has user interface for translations - using django-rosetta application and you can test out your translations almost immediately (well, whithin 10 minutes or so - if things go well). Please help us translate!

13.2k

Evgeny

updated 2010-04-30 10:57:10 -0600, asked 2010-04-08 14:57:02 -0600

edit flag offensive 0 remove flag close merge delete

Comments

add a comment see more comments

7 Answers

Sort by

oldest

newest

most voted

How to prepare the translator's environment

This answer assumes that your application source code has already been prepared for the internationalization (askbot is) and explains how to prepare a file holding the translation messages. Ideally this file is the only thing that translator needs to touch in order to do his work.

There are two ways to get started, in either case you will have to type some stuff into the command line of your OS.

Let's assume you are translating to Russian and your operating system is Unix-like.

Start from scratch or update an existing translation

By starting from scratch it is meant that you are not using any prepared localization for another language and instead you are just pulling the string keys from the project source files.

This method also works when source files get out of sync with your translation and you want to update it.

open the command shell in the directory that contains your settings.py file
type python manage.py makemessages -l ru -e html,py,txt

Note: the above command assumes that your translations are in the django site project directory, which is not always the case. For example, in askbot the localization files are inside the directory askbot, so in such cases the command will be:

cd askbot
python ../manage.py jinja2_makemessages -l ru -e html,py,txt

Notice the ../manage.py. Also, in askbot the message extraction command is customized, so it is called jinja2_makemessages instead of the django's makemessages.

The command above will create/update a file ./locale/ru/LC_MESSAGES/django.po - that file will be the main focus of your translation effort. .po files are meant to be edited by the translators. There are some format requirements to follow, but they are easier than those used in the source code and contain no programming logic.

If you are working on Windows, the command will start with python.exe, but will be the same otherwise. ru - is the language code (locale in computer parlance).

Start from another language translation

This method is perfect if there is a good quality localization that you understand, and is the only sane way if application abbreviates the string keys.

All you need here is just copy the translation directory (say English - ./locale/en) and name it ./locale/ru:

 cd locale
 cp -r en ru #copy the directories recursively
 cd ..       #get back to the root of your django site

What's next?

Now you have the ./locale/ru/LC_MESSAGES/django.po file. All that you need to do now is to translate those hundreds of messages into your language :).

Open the file in your favorite text editor and type away, but you will have to pay attention to some very specific issues - pluralization, insertion of variables and be careful with typing html tags into the translation strings.

13.2k

Evgeny

updated 2011-04-05 11:48:12 -0600, answered 2010-04-08 15:07:16 -0600

edit flag offensive 0 remove flag delete link

Comments

It would be helpful if catalogue was collected with jinja2_makemessages --no-wrap. Different versions of rosetta break lines differently, which leads to chaos in version control system -- hard to see what really changed and where.

piskvorky (2011-12-20 01:30:56 -0600) edit

SyntaxError: Translation blocks must not include other block tags: - endtrans (f ile skins\default\templates\email\macros.html, line 19) when I used jinja2_makemessages to translate some strings in Askbot.

jqy3222089 (2012-11-30 02:37:34 -0600) edit

add a comment see more comments

Hi,

I'm giving my first steps with python/django/mezzanine so please bear with me.

I modified a translation file and compiled it ok.

The translated file belongs to mezzanine's blog application and the only place I found out I could place it to test was at the blog app's locale folder (~/MY_VIRTUAL_ENV/lib/python2.7/site-packages/mezzanine/blog/locale/es/LC_MESSAGES).

It worked fine, but my guts tell me there has to be a way I can have this file(s) in some other location WITHIN my own mezzanine application so:

I can easily maintain it and
I don't have to keep my whole virtual environment in my SCM's repository.

Am I in the right track? If so, where should I place my new own translation files?

Thanks a lot in advanced

nimbiotics

answered 2013-10-04 00:23:47 -0600

edit flag offensive 0 remove flag delete link

Comments

in that case you can add a locale directory in your project and add it to LOCALE_PATHS in your settings.py that way every app [that you use will be translated directly in your project code info here: https://docs.djangoproject.com/en/dev/ref/settings/#locale-paths :-)

Fitoria (2013-10-04 15:55:42 -0600) edit

I haven't tried that possibility yet, my concern in this case however is whether or not I'll have to translate everything (django, mezzanine and all apps) when Im just basically changing (literally) a couple of words found in one application. I will be trying this path and report my findings in a couple of hours. Thanks for your input!

nimbiotics (2013-10-04 16:05:59 -0600) edit

No, you wont have to translate everything if it already exits on the app locale it will be showed on the generated PO so you'll have a starting point.

Fitoria (2013-10-04 16:08:48 -0600) edit

Thanks again, will try and report soon!

nimbiotics (2013-10-04 16:19:28 -0600) edit

It didn't work for me. Please take a look the this paste: http://pastebin.com/c8pvKLXQ. It shows my tree and the value of LOCALE_PATHS at the end of settings.py Any and all input welcome. Thanks in advanced!

nimbiotics (2013-10-04 17:31:39 -0600) edit

add a comment see more comments

How to compile translations?

If you have finished translating the content of your .po file - all you need to do is to compile the messages into machine-readable binary form. Run:

cd askbot
python ../manage.py compilemessages

If all goes well - your translation is ready for use, otherwise - fix any errors in the .po file and rerun the command.

Finally, if you have not done it yet - adjust the value of LANGUAGE_CODE variable to 'ru' in the case above.

13.2k

Evgeny

updated 2011-04-05 11:42:03 -0600, answered 2010-04-22 05:21:31 -0600

edit flag offensive 0 remove flag delete link

Comments

"python ../manage.py compilemessages" returned an error on my system (CentOS). I had to install "gettext". ("apt-get install gettext" or "yum install gettext"). You might want to put that information somewhere.

Tomasz P. Szynalski (2011-06-25 01:41:48 -0600) edit

On mac: "brew install gettext" followed by "brew link gettext"

mynameistechno (2013-03-20 14:34:16 -0600) edit

add a comment see more comments

What you could try is Get Localization and https://github.com/getlocalization/django-getlocalization">django-getlocalization to sync your Django app's .po files with GL easily.

petteri

updated 2011-07-13 06:51:10 -0600, answered 2011-07-13 06:49:35 -0600

edit flag offensive 0 remove flag delete link

Comments

add a comment see more comments

How to translate `django.po` files

First open file in the text editor (e.g. locale/ru/LC_MESSAGES/django.po)

In the simplest situation you will have lines like these:

#: django_authopenid/forms.py:162
msgid "Welcome to our website!"
msgstr ""

The string keys (translatable strings in the source code) are prefixed with msgid - you should never touch those (even if they look strange)! Your translations should go into strings starting with msgstr. If you do decide to change the key - instead of changing it in the django.po file do it in the source code and use command makemessages to rebuild the django.po file(s).

Strings themselves (both keys and translations) are always enclosed into double quotes. (If you need to use double quote inside the string itself - escape it with a backslash "string with a \" - double quote"). Backslash indicates start of the "escape sequence" - often indicating a special character \n means "new line" or an entry delimiter (double quote in this case).

So in the simple case above the Russian translation will look this way

msgid "Welcome to our website!"
msgstr "Добро пожаловать на наш сайт!"

Comments are important

In the previous example there was a line

#: django_authopenid/forms.py:162

This is a comment (because it starts with #) - do not delete or modify this type of comment as it tells where in the source code this message is coming from. You will use this comment when you decide to modify the translation key. The same string can be actually used in many places throughout the program and the comment will list all of them.

There is one case when you do need to edit comment - when you see line starting with

#, fuzzy

, fuzzy note indicates that the key string has been changed in the source file and the gettext system has guessed the meaning of the string. This comment is actually trying to help you locate strings that need your attention - so check the translation of those and then delete the , fuzzy part.

Make sure to never delete anything that might follow that comment on the same line. For example change:

#, fuzzy, python-format

#, python-format

Do not delete the whole line in this case. (However you can delete the whole comment if it contains only , fuzzy note).

Translating strings with variables

Here is a simple example of a string with a variable (comments with line numbers are omitted):

#, python-format
msgid "see questions tagged '%(tag)s'"
msgstr ""

The key has %(tag)s - that's the most important part. It means that value of a variable named "tag" will be inserted into the string - by the program. Name of the variable is enclosed into parentheses () and preceded by %; s right after the closing parenthesis ) means that variable is of string type. Finally, comment #, python-format instructs the gettext system that this translation is prepared for a program written in python programming language.

Here is how translation might look like:

#, python-format
msgid "see questions tagged '%(tag)s'"
msgstr "вопросы по темам ...

(more)

13.2k

Evgeny

updated 2010-04-22 05:59:04 -0600, answered 2010-04-21 06:21:15 -0600

edit flag offensive 0 remove flag delete link

Comments

add a comment see more comments

What is internationalization?

Internationalization includes two things (1) preparing of your software to be translated to other languages and (2) creating the translations themselves. Internationalization is long word and is abbreviated as i18n - because there are 18 characters between first i and last n.

The two step process makes life a lot easier for the programmers, designers of the user interface and the translators, because this way each can focus on his/her work without having to learn tricks of the trade of the others.

13.2k

Evgeny

updated 2010-04-08 15:50:53 -0600, answered 2010-04-08 15:42:41 -0600

edit flag offensive 0 remove flag delete link

Comments

add a comment see more comments

If you’re interested to localize web software, PC software, mobile software or any other type of software, go for this quick and simple online localization tool: https://poeditor.com/ It's quick and neat and has great collaborative and crowdsourcing potential.

summ3rs

answered 2014-04-28 09:25:50 -0600

edit flag offensive 0 remove flag delete link

Comments

add a comment see more comments

How to translate django applications? edit

Comments

7 Answers

How to prepare the translator's environment

Start from scratch or update an existing translation

Start from another language translation

What's next?

Comments

Comments

How to compile translations?

Comments

Comments

How to translate django.po files

Comments are important

Translating strings with variables

Comments

What is internationalization?

Comments

Comments

How to translate django applications?

How to translate `django.po` files