Docs about i18n_patterns() + JS translation catalog view needs enhancements

[George Tantiras]

To translate a string in a javascript file, the ​docs propose the following setup in the urls.py:

from django.views.i18n import javascript_catalog

js_info_dict = {
    'packages': ('your.app.package',),
}

urlpatterns = [
    url(r'^jsi18n/$', javascript_catalog, js_info_dict),
]

This will not work unless the javascript url is added to urlpatterns under i18n_patterns:

from django.views.i18n import javascript_catalog
from django.conf.urls.i18n import i18n_patterns

js_info_dict = {
    'packages': ('application.name',),
}

urlpatterns = [
    ...
]

urlpatterns += i18n_patterns(
    url(r'^jsi18n/$', javascript_catalog, js_info_dict),
)

[Simon Charette]

I think you don't need i18n_patterns as long as you use LocaleMiddleware.

[George Tantiras]

I had placed LocaleMiddleware to the specific place described in the docs.

I could not receive the translation whatsoever although makemessages was working as expected.

Then I bumped to a forgotten ​stackoverflow post.

It felt like I won the lottery!

This was my configuration:

urls.py

    js_info_dict = {
        'packages': ('market',),
    }
    
    urlpatterns = [url(r'^jsi18n/$', javascript_catalog, js_info_dict), ]
    
    urlpatterns += i18n_patterns(
        url(r'^$', HomePage.as_view(), name='home'),
    )

settings.py

    LOCALE_PATHS = (
        pjoin(BASE_DIR, '00', 'locale'),
    )
    
    # Middleware ===================================================================
    MIDDLEWARE_CLASSES = (
        'django.contrib.sessions.middleware.SessionMiddleware',
        'django.middleware.locale.LocaleMiddleware',
        'django.middleware.common.CommonMiddleware',
        'django.middleware.csrf.CsrfViewMiddleware',
        'django.contrib.auth.middleware.AuthenticationMiddleware',
        'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
        'django.contrib.messages.middleware.MessageMiddleware',
        'django.middleware.clickjacking.XFrameOptionsMiddleware',
        'django.middleware.security.SecurityMiddleware',
    )
    
    # Internationalization =========================================================
    LANGUAGE_CODE = 'en'
    TIME_ZONE = 'Europe/Paris'
    USE_I18N = True
    USE_L10N = True
    USE_TZ = True
    LANGUAGES = (
        ('en', gettext_noop('English')),
        ('fr', gettext_noop('French')),
    )

home.html (The script is successfully loaded)

    <script type="text/javascript" src="{% url 'django.views.i18n.javascript_catalog' %}"></script>

[Simon Charette]

Using i18n_patterns will make translations available under a language specific namespace instead of relying on the _language session key, django_language cookie and Accept-Language header.

What happens if you try access the non-i18n namespaced URL with an empty session and an Accept-Language header set to fr?

[George Tantiras]

Actually I do not have access to my computer now, but what was actually happening was that when I reached the url:
/fr/my_page everything was translated to French except for the Javascript strings.

I will also have to study some more in order to achieve accessing the url with an empty session and an Accept-Language header set to fr!

[Simon Charette]

From what I understand your main url_patterns (the one defined by ROOT_URLCONF) uses i18n_patterns.

In this case LocaleMiddleware will behave ​differently by solely relying on the ​request path to determine the active language.

I guess we should add a note in the i18n_patterns documentation stating if used all translated content views must also be placed within it.

[George Tantiras]

That seems to be the issue, after all.

Thank you!

[Tim Graham]

​PR

[Tim Graham <timograham@…>]

In 9524fd9:

Fixed #25751 -- Doc'd how to use JavaScriptCatalog with i18n_patterns().

[Tim Graham <timograham@…>]

In cdc343ca:

[1.10.x] Fixed #25751 -- Doc'd how to use JavaScriptCatalog with i18n_patterns().

Backport of 9524fd9133e47fa90846904f81fe91c72f331e56 from master