django-localeurl / docs / setup.rst

Installation

This section describes how to install the localeurl application in your Django project.

Prerequisites

The localeurl application requires Django 1.0 or higher.

Setup

Setup consists of installing the middleware and adding 'localeurl' to the installed applications list.

  1. Add 'localeurl.middleware.LocaleURLMiddleware' to settings.MIDDLEWARE_CLASSES. It must come before 'django.middleware.common.CommonMiddleware' or settings.APPEND_SLASH will not work. Make sure Django's built-in LocaleMiddleware is not in your MIDDLEWARE_CLASSES setting; LocaleURLMiddleware replaces it and the two will not work together. It must also come after django.contrib.sessions.middleware.SessionMiddleware if you plan using the session fallback (see LOCALEURL_USE_SESSION below).

  2. Add 'localeurl' to settings.INSTALLED_APPS. Because the application needs to replace the standard urlresolvers.reverse function, it is important to place it at the top of the list:

    INSTALLED_APPS = (
        'localeurl',
        ...
    )
    
  3. If you want to use the view, include the localeurl URLconf module in your project:

    urlpatterns = patterns('',
        ...
        (r'^localeurl/', include('localeurl.urls')),
        ...
    )
    
  4. Make sure settings.LANGUAGE_CODE or its root language is in settings.LANGUAGES. For example, if LANGUAGE_CODE == 'en-us' then LANGUAGES must contain either 'en-us' or 'en'. If you have not changed either option you do not have to do anything.

Configuration

The application can be configured by editing the project's settings.py file.

LOCALE_INDEPENDENT_PATHS

A tuple of regular expressions matching paths that will not be redirected to add the language prefix. For example, a site with a language selection splash page would add '^/$' as a locale independent path match.

Example:

LOCALE_INDEPENDENT_PATHS = (
    r'^/$',
    r'^/games/',
    r'^/ajax/',
)
LOCALE_INDEPENDENT_MEDIA_URL (default: True)
Whether paths starting with settings.MEDIA_URL (if it is a path, i.e. not a full URL) are considered to be locale-independent.
LOCALE_INDEPENDENT_STATIC_URL (default: True)
Whether paths starting with settings.STATIC_URL (if it is a path, i.e. not a full URL) are considered to be locale-independent.
PREFIX_DEFAULT_LOCALE (default: True)
Whether to add the prefix for the default language (settings.LANGUAGE_CODE). For example, if LANGUAGE_CODE == 'en' then the path /about/ will be passed to the URL resolver unchanged and /en/about/ will be redirected to /about/.
LOCALEURL_USE_ACCEPT_LANGUAGE (default: False)
Whether to check the Accept-Language header from the browser as an intermediate fallback in case no locale is specified in the URL. (The default behavior, preserved for backwards compatibility, is to fallback directly to settings.LANGUAGE_CODE).

LOCALEURL_USE_SESSION (default: False)

Whether to check for a user-selected locale in the Django session as a fallback in case no locale is specified in the URL. If True, the change_locale view will save the chosen locale to the user's session under the django_language session key. When used and available, the session locale takes precedence over the Accept-Language header fallback (see LOCALEURL_USE_ACCEPT_LANGUAGE above).

A localized URL still takes precedence over a locale in the user's session. Following a localized link such as one generated using the chlocale filter won't switch the session's django_language; only the change_locale view will.

To use this feature, sessions must be in use, and django.contrib.sessions.middleware.SessionMiddleware must come before localeurl.middleware.LocaleURLMiddleware in settings.MIDDLEWARE_CLASSES.

LOCALE_REDIRECT_PERMANENT (default: True)
Whether to use a permanent redirect (301 status code) or temporary redirect (302) when redirecting users from the no-locale version of a URL to the default locale (or the locale specified in their Accept-Language header if LOCALEURL_USE_ACCEPT_LANGUAGE is True). If Accept-Language is not used, these redirects will never change (as long as the default locale never changes), so 301 (the default) is a fine choice. If you use Accept-Language you may want to consider switching this to False, as the redirect will then be dependent on the user's Accept-Language header.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.