transurlvania 0.2.4

Language in Path

• Add transurlvania.middleware.LangInPathMiddleware to MIDDLEWARE_CLASSES after LocaleMiddleware.

• Make these changes to your root URL conf module:

  • If you haven’t already done so, replace from django.conf.urls.defaults import * with from transurlvania.defaults import *.

  • Replace the call to patterns that populates the urlpatterns variable with a call to lang_prefixed_patterns.

  • To handle requests to the root URL itself (“/”) or any URLs you wish to keep outside of the language prefixing, declare the URL patterns as normal inside a call to patterns and append the result to the urlpatterns variable.

  Here’s an example of what a root URLconf might look like before adding language prefixing:

  from django.contrib import admin
  from django.utils.translation import ugettext_noop as _
  
  from transurlvania.defaults import *
  
  admin.autodiscover()
  
  urlpatterns = patterns('example.views',
      url(r'^$', 'home'),
      url(r'^admin/', include(admin.site.urls)),
      url(_(r'^about-us/$'), 'about_us', name='about_us'),
  )

  And here’s what it would look like after it’s been converted:

  from django.contrib import admin
  from django.utils.translation import ugettext_noop as _
  
  from transurlvania.defaults import *
  
  admin.autodiscover()
  
  urlpatterns = lang_prefixed_patterns('example.views',
      url(r'^$', 'home'),
      url(r'^admin/', include(admin.site.urls)),
      url(_(r'^about-us/$'), 'about_us', name='about_us'),
  )
  
  
  urlpatterns += patterns('example.views',
      url(r'^$', 'language_selection_splash'),
      )

Language in Domain

• Add transurlvania.middleware.LangInDomainMiddleware to MIDDLEWARE_CLASSES after LocaleMiddleware.

• Add MULTILANG_LANGUAGE_DOMAINS to the project’s settings module.

  This settings should be a dictionary mapping language codes to two-element tuples, where the first element is the domain for that language, and the second element is the name of the site this represents.

  Example:

  MULTILANG_LANGUAGE_DOMAINS = {
      'en': ('www.example-en.com', 'English Site'),
      'fr': ('www.example-fr.com', 'French Site')
  }

Language Switching

Django’s language switching view is incompatible with transurlvania’s techniques for setting site language using the URL. transurlvania provides its own language switching tools that make it possible to link directly to the loaded page’s alternate-language equivalent.

The main requirement for this functionality is that transurlvania.middleware.URLTransMiddleware is in MIDDLEWARE_CLASSES, and transurlvania.context_processors.translate is in TEMPLATE_CONTEXT_PROCESSORS. With these installed you can then use the this_page_in_lang template tag to get the URL for the page currently being viewed in the language requested.

So, {% this_page_in_lang "fr" %} would return the URL to the French version of the page being displayed.

The language switching code has two schemes for determining the URL to use:

1. If there’s a variable named object in the context, and that variable implements a method named get_translation, the switcher will call the method with the requsted language, call get_absolute_url on what’s returned and then use that URL for the translation.

2. If the first method fails, the switcher will call transurlvania’s reverse_for_language function using the view name and the parameters that were resolved from the current request.

There are cases where neither of these schemes will work such as when the object isn’t named object, or when the same view is used by multiple URLs. In those cases, you can use the decorators provided by the translators module to decorate the view and change which URL look-up scheme is used. You can also define your own look-up schemes.