Permalink
Browse files

Fixed #20774 -- Mention the new django-localflavor app as a replaceme…

…nt for the contrib app.
  • Loading branch information...
jezdez committed Jul 26, 2013
1 parent 0b35a2c commit 33e6cf5ec324bb1154ae1a0379f9c9ef6ff51420
Showing with 18 additions and 62 deletions.
  1. +18 −62 docs/topics/localflavor.txt
@@ -7,8 +7,9 @@ assorted pieces of code that are useful for particular countries or cultures.
This code is now distributed separately from Django, for easier maintenance
and to trim the size of Django's codebase.
The localflavor packages are named ``django-localflavor-*``, where the asterisk
is an `ISO 3166 country code`_. For example: ``django-localflavor-us`` is the
The new localflavor package is named ``django-localflavor``, with a main
module called ``localflavor`` and many subpackages using an
`ISO 3166 country code`_. For example: ``localflavor.us`` is the
localflavor package for the U.S.A.
Most of these ``localflavor`` add-ons are country-specific fields for the
@@ -22,7 +23,7 @@ For example, here's how you can create a form with a field representing a
French telephone number::
from django import forms
from django_localflavor_fr.forms import FRPhoneNumberField
from localflavor.fr.forms import FRPhoneNumberField
class MyForm(forms.Form):
my_french_phone_no = FRPhoneNumberField()
@@ -37,85 +38,40 @@ file.
Supported countries
===================
The following countries have django-localflavor- packages.
* Argentina: https://github.com/django/django-localflavor-ar
* Australia: https://github.com/django/django-localflavor-au
* Austria: https://github.com/django/django-localflavor-at
* Belgium: https://github.com/django/django-localflavor-be
* Brazil: https://github.com/django/django-localflavor-br
* Canada: https://github.com/django/django-localflavor-ca
* Chile: https://github.com/django/django-localflavor-cl
* China: https://github.com/django/django-localflavor-cn
* Colombia: https://github.com/django/django-localflavor-co
* Croatia: https://github.com/django/django-localflavor-hr
* Czech Republic: https://github.com/django/django-localflavor-cz
* Ecuador: https://github.com/django/django-localflavor-ec
* Finland: https://github.com/django/django-localflavor-fi
* France: https://github.com/django/django-localflavor-fr
* Germany: https://github.com/django/django-localflavor-de
* Greece: https://github.com/spapas/django-localflavor-gr
* Hong Kong: https://github.com/django/django-localflavor-hk
* Iceland: https://github.com/django/django-localflavor-is
* India: https://github.com/django/django-localflavor-in
* Indonesia: https://github.com/django/django-localflavor-id
* Ireland: https://github.com/django/django-localflavor-ie
* Israel: https://github.com/django/django-localflavor-il
* Italy: https://github.com/django/django-localflavor-it
* Japan: https://github.com/django/django-localflavor-jp
* Kuwait: https://github.com/django/django-localflavor-kw
* Lithuania: https://github.com/simukis/django-localflavor-lt
* Macedonia: https://github.com/django/django-localflavor-mk
* Mexico: https://github.com/django/django-localflavor-mx
* The Netherlands: https://github.com/django/django-localflavor-nl
* Norway: https://github.com/django/django-localflavor-no
* Peru: https://github.com/django/django-localflavor-pe
* Poland: https://github.com/django/django-localflavor-pl
* Portugal: https://github.com/django/django-localflavor-pt
* Paraguay: https://github.com/django/django-localflavor-py
* Romania: https://github.com/django/django-localflavor-ro
* Russia: https://github.com/django/django-localflavor-ru
* Slovakia: https://github.com/django/django-localflavor-sk
* Slovenia: https://github.com/django/django-localflavor-si
* South Africa: https://github.com/django/django-localflavor-za
* Spain: https://github.com/django/django-localflavor-es
* Sweden: https://github.com/django/django-localflavor-se
* Switzerland: https://github.com/django/django-localflavor-ch
* Turkey: https://github.com/django/django-localflavor-tr
* United Kingdom: https://github.com/django/django-localflavor-gb
* United States of America: https://github.com/django/django-localflavor-us
* Uruguay: https://github.com/django/django-localflavor-uy
See the official documentation for more information:
https://django-localflavor.readthedocs.org/
Internationalization of localflavors
====================================
To activate translations for a ``localflavor`` application, you must include
the application's name (e.g. ``django_localflavor_jp``) in the
:setting:`INSTALLED_APPS` setting, so the internationalization system can find
the catalog, as explained in :ref:`how-django-discovers-translations`.
To activate translations for the ``localflavor`` application, you must include
the application's name in the :setting:`INSTALLED_APPS` setting, so the
internationalization system can find the catalog, as explained in
:ref:`how-django-discovers-translations`.
.. _localflavor-how-to-migrate:
How to migrate
==============
If you've used the old ``django.contrib.localflavor`` package, follow these two
easy steps to update your code:
If you've used the old ``django.contrib.localflavor`` package or one of the
temporary ``django-localflavor-*`` releases, follow these two easy steps to
update your code:
1. Install the appropriate third-party ``django-localflavor-*`` package(s).
Go to https://github.com/django/ and find the package for your country.
1. Install the third-party ``django-localflavor`` package from PyPI.
2. Change your app's import statements to reference the new packages.
2. Change your app's import statements to reference the new package.
For example, change this::
from django.contrib.localflavor.fr.forms import FRPhoneNumberField
...to this::
from django_localflavor_fr.forms import FRPhoneNumberField
from localflavor.fr.forms import FRPhoneNumberField
The code in the new packages is the same (it was copied directly from Django),
The code in the new package is the same (it was copied directly from Django),
so you don't have to worry about backwards compatibility in terms of
functionality. Only the imports have changed.

0 comments on commit 33e6cf5

Please sign in to comment.