Translations in Django templates uses two template tags and a slightly different syntax than in Python code. To give your template access to these tags, put {% load i18n %} toward the top of your template. As with all template tags, this tag needs to be loaded in all templates which use translations, even those templates that extend from other templates which have already loaded the i18n tag.<\/p>\n
trans Template Tag
\nThe {% trans %} template tag translates either a constant string (enclosed in single or double quotes) or variable content:<\/p>\n
<title>{% trans “This is the title.”
\n%}<\/title>
\n<title>{% trans myvar %}<\/title><\/p>\n
If the noop option is present, variable lookup still takes place but the translation is skipped. This is useful when stubbing out content that will require translation in the future:<\/p>\n
<title>{% trans “myvar” noop %}<\/title><\/p>\n
Internally, inline translations use an ugettext() call.<\/p>\n
In case a template variable (myvar above) is passed to the tag, the tag will first resolve such variable to a string at run-time and then look up that string in the message catalogs.<\/p>\n
It\u2019s not possible to mix a template variable inside a string within {% trans %}. If your translations require strings with variables (placeholders), use {% blocktrans %} instead. If you\u2019d like to retrieve a translated string without displaying it, you can use the following syntax:<\/p>\n
{% trans “This is the title” as the_title %}<\/p>\n
In practice you\u2019ll use this to get strings that are used in multiple places or should be used as arguments for other template tags or filters:<\/p>\n
{% trans “starting point” as start %}
\n{% trans “end point” as end %}
\n{% trans “La Grande Boucle” as race %}<\/p>\n
<h1>
\n<a href=”\/” title=”{% blocktrans %}Back to ‘{{ race }}’
\nhomepage{% endblocktrans %}”>{{ race }}<\/a>
\n<\/h1>
\n<p>
\n{% for stage in tour_stages %}
\n{% cycle start end %}: {{ stage }}{% if forloop.counter|divisibleby:2 %}<br \/>{% \\
\nelse %}, {% endif %}
\n{% endfor %}
\n<\/p><\/p>\n
{% trans %} also supports contextual markers using the context keyword:<\/p>\n
{% trans “May” context “month name” %}
\nblocktrans Template Tag
\nThe blocktrans tag allows you to mark complex sentences consisting of literals and variable content for translation by making use of placeholders:<\/p>\n
{% blocktrans %}This string will have {{ value }} inside.{% endblocktrans %}<\/p>\n
To translate a template expression<\/strong> \u2013 say, accessing object attributes or using template filters \u2013 you need to bind the expression to a local variable for use within the translation block. Examples:<\/p>\n {% blocktrans with amount=article.price %} {% blocktrans with myvar=value|filter %} You can use multiple expressions inside a single blocktrans tag:<\/p>\n {% blocktrans with book_t=book|title author_t=author|title %} The previous more verbose format is still supported:<\/p>\n {% blocktrans with book|title as book_t and author|title as author_t %}<\/p>\n Other block tags (for example {% for %} or {% if %}) are not allowed inside a blocktrans tag.<\/p>\n If resolving one of the block arguments fails, blocktrans will fall back to the default language by deactivating the currently active language temporarily with the deactivate_all() function.<\/p>\n This tag also provides for pluralization. To use it:<\/p>\n An example: A more complex example: When you use both the pluralization feature and bind values to local variables in addition to the counter value, keep in mind that the blocktrans construct is internally converted to an ungettext call. This means the same notes regarding ungettext variables apply.<\/p>\n Reverse URL lookups cannot be carried out within the blocktrans and should be retrieved (and stored) beforehand:<\/p>\n {% url ‘path.to.view’ arg arg2 as the_url %} {% blocktrans %} also supports contextual using the context keyword:<\/p>\n {% blocktrans with name=user.username context “greeting” %} Another feature {% blocktrans %} supports is the trimmed option. This option will remove newline characters from the beginning and the end of the content of the {% blocktrans %} tag, replace any whitespace at the beginning and end of a line and merge all lines into one using a space character to separate them.<\/p>\n This is quite useful for indenting the content of a {% blocktrans %} tag without having the indentation characters end up in the corresponding entry in the PO file, which makes the translation process easier.<\/p>\n For instance, the following {% blocktrans %} tag:<\/p>\n {% blocktrans trimmed %} will result in the entry “First sentence. Second paragraph.” in the PO file, compared to “\\n First sentence.\\n Second sentence.\\n”, if the trimmed option had not been specified. In this case, both the tag and the filter will see the translated string, so they don\u2019t need to be aware of translations.<\/p>\n In this example, the translation infrastructure will be passed the string \u201cyes,no\u201d, not the individual strings \u201cyes\u201d and \u201cno\u201d. The translated string will need to contain the comma so that the filter parsing code knows how to split up the arguments. For example, a German translator might translate the string \u201cyes,no\u201d as \u201cja,nein\u201d (keeping the comma intact).<\/p>\n Just like with Python code, these notes for translators can be specified using comments, either with the comment tag:<\/p>\n {% comment %}Translators: View verb{% endcomment %} {% comment %}Translators: Short intro blurb{% endcomment %} or with the {# \u2026 #} one-line comment constructs:<\/p>\n {# Translators: Label of a button that triggers search #} {# Translators: This is a text of the base template #} Just for completeness, these are the corresponding fragments of the resulting .po file:<\/p>\n #. Translators: View verb #. Translators: Short intro blurb # …<\/p>\n #. Translators: Label of a button that triggers search #. Translators: This is a text of the base template If you want to select a language within a template, you can use the language template tag:<\/p>\n {% load i18n %}<\/p>\n {% get_current_language as LANGUAGE_CODE %} {% language ‘en’ %}<\/p>\n {% get_current_language as LANGUAGE_CODE %} {% endlanguage %}<\/p>\n While the first occurrence of Welcome to our page uses the current language, the second will always be in English.<\/p>\n These tags also require a {% load i18n %}.<\/p>\n If you enable the django.template.context_processors.i18n context processor then each RequestContext will have access to LANGUAGES, LANGUAGE_CODE, and LANGUAGE_BIDI as defined above.<\/p>\n The i18n context processor is not enabled by default for new projects.<\/p>\n You can also retrieve information about any of the available languages using provided template tags and filters. To get information about a single language, use the {% get_language_info %} tag:<\/p>\n {% get_language_info for LANGUAGE_CODE as lang %} You can then access the information:<\/p>\n Language code: {{ lang.code }}<br \/> You can also use the {% get_language_info_list %} template tag to retrieve information for a list of languages (e.g. active languages as specified in LANGUAGES).<\/p>\n In addition to LANGUAGES style list of tuples, {% get_language_info_list %} supports simple lists of language codes. If you do this in your view:<\/p>\n context = {‘available_languages’: [‘en’, ‘es’, ‘fr’]} you can iterate over those languages in the template:<\/p>\n {% get_language_info_list for available_languages as langs %} There are also simple filters available for convenience: Django provides two mechanisms to internationalize URL patterns:<\/p>\n Using either one of these features requires that an active language be set for each request; in other words, you need to have django.middleware.locale.LocaleMiddleware in your MIDDLEWARE_CLASSES setting.<\/p>\n Language Prefix in URL Patterns<\/strong> – This function can be used in your root URLconf and Django will automatically prepend the current active language code to all url patterns defined within i18n_patterns(). Example URL patterns:<\/p>\n from django.conf.urls import include, url urlpatterns = [ news_patterns = [ urlpatterns += i18n_patterns( After defining these URL patterns, Django will automatically add the language prefix to the URL patterns that were added by the i18n_patterns function. Example:<\/p>\n >>> from django.core.urlresolvers import reverse >>> activate(‘nl’) i18n_patterns() is only allowed in your root URLconf. Using it within an included URLconf will throw an ImproperlyConfigured exception.<\/p>\n Translating URL Patterns<\/strong> – URL patterns can also be marked translatable using the ugettext_lazy() function. Example:<\/p>\n from django.conf.urls import include, url from about import views as about_views urlpatterns = [ urlpatterns += i18n_patterns( After you\u2019ve created the translations, the reverse() function will return the URL in the active language. Example:<\/p>\n from django.core.urlresolvers import reverse >>> activate(‘en’) >>> activate(‘nl’) In most cases, it\u2019s best to use translated URLs only within a language-code-prefixed block of patterns (using i18n_patterns()), to avoid the possibility that a carelessly translated URL causes a collision with a non-translated URL pattern.<\/p>\n
\nThat will cost $ {{ amount }}.
\n{% endblocktrans %}<\/p>\n
\nThis will have {{ myvar }} inside.
\n{% endblocktrans %}<\/p>\n
\nThis is {{ book_t }} by {{ author_t }}
\n{% endblocktrans %}<\/p>\n\n
\n{% blocktrans count counter=list|length %}
\nThere is only one {{ name }} object.
\n{% plural %}
\nThere are {{ counter }} {{ name }} objects.
\n{% endblocktrans %}<\/p>\n
\n{% blocktrans with amount=article.price count years=i.length %}
\nThat will cost $ {{ amount }} per year.
\n{% plural %}
\nThat will cost $ {{ amount }} per {{ years }} years.
\n{% endblocktrans %}<\/p>\n
\n{% blocktrans %}
\nThis is a URL: {{ the_url }}
\n{% endblocktrans %}<\/p>\n
\nHi {{ name }}{% endblocktrans %}<\/p>\n
\nFirst sentence.
\nSecond paragraph.
\n{% endblocktrans %}<\/p>\n
\nString Literals Passed to Tags and Filters
\nYou can translate string literals passed as arguments to tags and filters by using the familiar _() syntax:
\n{% some_tag _(“Page not found”) value|yesno:_(“yes,no”) %}<\/p>\nComments for Translators in Templates<\/h3>\n
\n{% trans “View” %}<\/p>\n
\n<p>{% blocktrans %}
\nA multiline translatable literal.
\n{% endblocktrans %}
\n<\/p><\/p>\n
\n<button type=”submit”>{% trans “Go” %}<\/button><\/p>\n
\n{% blocktrans %}Ambiguous translatable block of text{% endblocktrans %}<\/p>\n
\n# path\/to\/template\/file.html:10
\nmsgid “View”
\nmsgstr “”<\/p>\n
\n# path\/to\/template\/file.html:13
\nmsgid “”
\n“A multiline translatable”
\n“literal.”
\nmsgstr “”<\/p>\n
\n# path\/to\/template\/file.html:100
\nmsgid “Go”
\nmsgstr “”<\/p>\n
\n# path\/to\/template\/file.html:103
\nmsgid “Ambiguous translatable block of text”
\nmsgstr “”<\/p>\nSwitching Language in Templates<\/h3>\n
\n<!– Current language: {{ LANGUAGE_CODE }} –>
\n<p>{% trans “Welcome to our page” %}<\/p><\/p>\n
\n<!– Current language: {{ LANGUAGE_CODE }} –>
\n<p>{% trans “Welcome to our page” %}<\/p><\/p>\nOther Tags<\/h3>\n
\n
\nExample: en-us.<\/li>\n
\n{% get_language_info for “pl” as lang %}<\/p>\n
\nName of language: {{ lang.name_local }}<br \/>
\nName in English: {{ lang.name }}<br \/>
\nBi-directional: {{ lang.bidi }}<\/p>\n
\nreturn render(request, ‘mytemplate.html’, context)<\/p>\n
\n{% for lang in langs %} … {% endfor %}<\/p>\n
\n{{ LANGUAGE_CODE|language_name }} (German)
\n{{ LANGUAGE_CODE|language_name_local }} (Deutsch)
\n{{ LANGUAGE_CODE|language_bidi }} (False)<\/p>\nInternationalization in URL Patterns<\/h3>\n
\n
\nfrom django.conf.urls.i18n import i18n_patterns
\nfrom about import views as about_views
\nfrom news import views as news_views
\nfrom sitemap.views import sitemap<\/p>\n
\nurl(r’^sitemap\\.xml$’, sitemap, name=’sitemap_xml’),
\n]\n
\nurl(r’^$’, news_views.index, name=’index’),
\nurl(r’^category\/(?P<slug>[\\w-]+)\/$’,
\nnews_views.category,
\nname=’category’),
\nurl(r’^(?P<slug>[\\w-]+)\/$’, news_views.details, name=’detail’),
\n]\n
\nurl(r’^about\/$’, about_views.main, name=’about’),
\nurl(r’^news\/’, include(news_patterns, namespace=’news’)),
\n)<\/p>\n
\n>>> from django.utils.translation import activate
\n>>> activate(‘en’)
\n>>> reverse(‘sitemap_xml’)
\n‘\/sitemap.xml’
\n>>> reverse(‘news:index’)
\n‘\/en\/news\/’<\/p>\n
\n>>> reverse(‘news:detail’, kwargs={‘slug’: ‘news-slug’})
\n‘\/nl\/news\/news-slug\/’<\/p>\n
\nfrom django.conf.urls.i18n import i18n_patterns
\nfrom django.utils.translation import ugettext_lazy as _<\/p>\n
\nfrom news import views as news_views
\nfrom sitemaps.views import sitemap<\/p>\n
\nurl(r’^sitemap\\.xml$’, sitemap, name=’sitemap_xml’),
\n]\nnews_patterns = [
\nurl(r’^$’, news_views.index, name=’index’),
\nurl(_(r’^category\/(?P<slug>[\\w-]+)\/$’),
\nnews_views.category,
\nname=’category’),
\nurl(r’^(?P<slug>[\\w-]+)\/$’, news_views.details, name=’detail’),
\n]\n
\nurl(_(r’^about\/$’), about_views.main, name=’about’),
\nurl(_(r’^news\/’), include(news_patterns, namespace=’news’)),
\n)<\/p>\n
\nfrom django.utils.translation import activate<\/p>\n
\n>>> reverse(‘news:category’, kwargs={‘slug’: ‘recent’})
\n‘\/en\/news\/category\/recent\/’<\/p>\n
\n>>> reverse(‘news:category’, kwargs={‘slug’: ‘recent’})
\n‘\/nl\/nieuws\/categorie\/recent\/’<\/p>\n