summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2023-01-06 14:46:33 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2023-01-17 11:49:15 +0100
commit8d98f99a4ab5de6f2c730399f53eba8bf6bea470 (patch)
treec9c643c4c77b0d5fb014270f62ba2ca193befc8a /docs
parent0be8095b254fad65b2480d677ebe6098c41bbad6 (diff)
Refs #32873 -- Removed settings.USE_L10N per deprecation timeline.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/forms/fields.txt21
-rw-r--r--docs/ref/settings.txt87
-rw-r--r--docs/ref/templates/builtins.txt9
-rw-r--r--docs/releases/5.0.txt2
-rw-r--r--docs/topics/i18n/formatting.txt21
-rw-r--r--docs/topics/i18n/index.txt7
6 files changed, 51 insertions, 96 deletions
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt
index 2aba907e03..3c61a14711 100644
--- a/docs/ref/forms/fields.txt
+++ b/docs/ref/forms/fields.txt
@@ -438,10 +438,9 @@ For each field, we describe the default widget used if you don't specify
``datetime.date`` object.
If no ``input_formats`` argument is provided, the default input formats are
- taken from :setting:`DATE_INPUT_FORMATS` if :setting:`USE_L10N` is
- ``False``, or from the active locale format ``DATE_INPUT_FORMATS`` key if
- localization is enabled. See also :doc:`format localization
- </topics/i18n/formatting>`.
+ taken from the active locale format ``DATE_INPUT_FORMATS`` key, or from
+ :setting:`DATE_INPUT_FORMATS` if localization is disabled. See also
+ :doc:`format localization </topics/i18n/formatting>`.
``DateTimeField``
-----------------
@@ -475,10 +474,9 @@ For each field, we describe the default widget used if you don't specify
* '2006-10-25'
If no ``input_formats`` argument is provided, the default input formats are
- taken from :setting:`DATETIME_INPUT_FORMATS` and
- :setting:`DATE_INPUT_FORMATS` if :setting:`USE_L10N` is ``False``, or from
- the active locale format ``DATETIME_INPUT_FORMATS`` and
- ``DATE_INPUT_FORMATS`` keys if localization is enabled. See also
+ taken from the active locale format ``DATETIME_INPUT_FORMATS`` and
+ ``DATE_INPUT_FORMATS`` keys, or from :setting:`DATETIME_INPUT_FORMATS` and
+ :setting:`DATE_INPUT_FORMATS` if localization is disabled. See also
:doc:`format localization </topics/i18n/formatting>`.
``DecimalField``
@@ -960,10 +958,9 @@ For each field, we describe the default widget used if you don't specify
``datetime.time`` object.
If no ``input_formats`` argument is provided, the default input formats are
- taken from :setting:`TIME_INPUT_FORMATS` if :setting:`USE_L10N` is
- ``False``, or from the active locale format ``TIME_INPUT_FORMATS`` key if
- localization is enabled. See also :doc:`format localization
- </topics/i18n/formatting>`.
+ taken from the active locale format ``TIME_INPUT_FORMATS`` key, or from
+ :setting:`TIME_INPUT_FORMATS` if localization is disabled. See also
+ :doc:`format localization </topics/i18n/formatting>`.
``TypedChoiceField``
--------------------
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 777dc18c50..f315e5ef6c 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -1097,9 +1097,8 @@ database configurations <topics-db-multi-db-routing>`.
Default: ``'N j, Y'`` (e.g. ``Feb. 4, 2003``)
The default formatting to use for displaying date fields in any part of the
-system. Note that if :setting:`USE_L10N` is set to ``True``, then the
-locale-dictated format has higher precedence and will be applied instead. See
-:tfilter:`allowed date format strings <date>`.
+system. Note that the locale-dictated format has higher precedence and will be
+applied instead. See :tfilter:`allowed date format strings <date>`.
See also :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATE_FORMAT`.
@@ -1130,8 +1129,7 @@ format strings use Python's :ref:`datetime module syntax
<strftime-strptime-behavior>`, not the format strings from the :tfilter:`date`
template filter.
-When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
-precedence and will be applied instead.
+The locale-dictated format has higher precedence and will be applied instead.
See also :setting:`DATETIME_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
@@ -1143,9 +1141,8 @@ See also :setting:`DATETIME_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
Default: ``'N j, Y, P'`` (e.g. ``Feb. 4, 2003, 4 p.m.``)
The default formatting to use for displaying datetime fields in any part of the
-system. Note that if :setting:`USE_L10N` is set to ``True``, then the
-locale-dictated format has higher precedence and will be applied instead. See
-:tfilter:`allowed date format strings <date>`.
+system. Note that the locale-dictated format has higher precedence and will be
+applied instead. See :tfilter:`allowed date format strings <date>`.
See also :setting:`DATE_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
@@ -1175,8 +1172,7 @@ these format strings use Python's :ref:`datetime module syntax
template filter. Date-only formats are not included as datetime fields will
automatically try :setting:`DATE_INPUT_FORMATS` in last resort.
-When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
-precedence and will be applied instead.
+The locale-dictated format has higher precedence and will be applied instead.
See also :setting:`DATE_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
@@ -1254,8 +1250,8 @@ Default: ``'.'`` (Dot)
Default decimal separator used when formatting decimal numbers.
-Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
-format has higher precedence and will be applied instead.
+Note that the locale-dictated format has higher precedence and will be applied
+instead.
See also :setting:`NUMBER_GROUPING`, :setting:`THOUSAND_SEPARATOR` and
:setting:`USE_THOUSAND_SEPARATOR`.
@@ -2170,8 +2166,8 @@ drilldown, the header for a given day displays the day and month. Different
locales have different formats. For example, U.S. English would say
"January 1," whereas Spanish might say "1 Enero."
-Note that if :setting:`USE_L10N` is set to ``True``, then the corresponding
-locale-dictated format has higher precedence and will be applied.
+Note that the corresponding locale-dictated format has higher precedence and
+will be applied instead.
See :tfilter:`allowed date format strings <date>`. See also
:setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`,
@@ -2203,8 +2199,8 @@ Example tuple for ``en_IN``::
NUMBER_GROUPING = (3, 2, 0)
-Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
-format has higher precedence and will be applied instead.
+Note that the locale-dictated format has higher precedence and will be applied
+instead.
See also :setting:`DECIMAL_SEPARATOR`, :setting:`THOUSAND_SEPARATOR` and
:setting:`USE_THOUSAND_SEPARATOR`.
@@ -2542,9 +2538,9 @@ The email address that error messages come from, such as those sent to
Default: ``'m/d/Y'`` (e.g. ``12/31/2003``)
An available formatting that can be used for displaying date fields on
-templates. Note that if :setting:`USE_L10N` is set to ``True``, then the
-corresponding locale-dictated format has higher precedence and will be applied.
-See :tfilter:`allowed date format strings <date>`.
+templates. Note that the corresponding locale-dictated format has higher
+precedence and will be applied instead. See
+:tfilter:`allowed date format strings <date>`.
See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
@@ -2556,9 +2552,9 @@ See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
Default: ``'m/d/Y P'`` (e.g. ``12/31/2003 4 p.m.``)
An available formatting that can be used for displaying datetime fields on
-templates. Note that if :setting:`USE_L10N` is set to ``True``, then the
-corresponding locale-dictated format has higher precedence and will be applied.
-See :tfilter:`allowed date format strings <date>`.
+templates. Note that the corresponding locale-dictated format has higher
+precedence and will be applied instead. See
+:tfilter:`allowed date format strings <date>`.
See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATE_FORMAT`.
@@ -2769,8 +2765,8 @@ Default thousand separator used when formatting numbers. This setting is
used only when :setting:`USE_THOUSAND_SEPARATOR` is ``True`` and
:setting:`NUMBER_GROUPING` is greater than ``0``.
-Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
-format has higher precedence and will be applied instead.
+Note that the locale-dictated format has higher precedence and will be applied
+instead.
See also :setting:`NUMBER_GROUPING`, :setting:`DECIMAL_SEPARATOR` and
:setting:`USE_THOUSAND_SEPARATOR`.
@@ -2783,9 +2779,8 @@ See also :setting:`NUMBER_GROUPING`, :setting:`DECIMAL_SEPARATOR` and
Default: ``'P'`` (e.g. ``4 p.m.``)
The default formatting to use for displaying time fields in any part of the
-system. Note that if :setting:`USE_L10N` is set to ``True``, then the
-locale-dictated format has higher precedence and will be applied instead. See
-:tfilter:`allowed date format strings <date>`.
+system. Note that the locale-dictated format has higher precedence and will be
+applied instead. See :tfilter:`allowed date format strings <date>`.
See also :setting:`DATE_FORMAT` and :setting:`DATETIME_FORMAT`.
@@ -2808,8 +2803,7 @@ format strings use Python's :ref:`datetime module syntax
<strftime-strptime-behavior>`, not the format strings from the :tfilter:`date`
template filter.
-When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
-precedence and will be applied instead.
+The locale-dictated format has higher precedence and will be applied instead.
See also :setting:`DATE_INPUT_FORMATS` and :setting:`DATETIME_INPUT_FORMATS`.
@@ -2882,32 +2876,13 @@ This provides a way to turn it off, for performance. If this is set to
``False``, Django will make some optimizations so as not to load the
translation machinery.
-See also :setting:`LANGUAGE_CODE`, :setting:`USE_L10N` and :setting:`USE_TZ`.
+See also :setting:`LANGUAGE_CODE` and :setting:`USE_TZ`.
.. note::
The default :file:`settings.py` file created by :djadmin:`django-admin
startproject <startproject>` includes ``USE_I18N = True`` for convenience.
-.. setting:: USE_L10N
-
-``USE_L10N``
-------------
-
-Default: ``True``
-
-A boolean that specifies if localized formatting of data will be enabled by
-default or not. If this is set to ``True``, e.g. Django will display numbers and
-dates using the format of the current locale.
-
-See also :setting:`LANGUAGE_CODE`, :setting:`USE_I18N` and :setting:`USE_TZ`.
-
-.. deprecated:: 4.0
-
- This setting is deprecated. Starting with Django 5.0, localized formatting
- of data will always be enabled. For example Django will display numbers and
- dates using the format of the current locale.
-
.. setting:: USE_THOUSAND_SEPARATOR
``USE_THOUSAND_SEPARATOR``
@@ -2916,10 +2891,9 @@ See also :setting:`LANGUAGE_CODE`, :setting:`USE_I18N` and :setting:`USE_TZ`.
Default: ``False``
A boolean that specifies whether to display numbers using a thousand separator.
-When set to ``True`` and :setting:`USE_L10N` is also ``True``, Django will
-format numbers using the :setting:`NUMBER_GROUPING` and
-:setting:`THOUSAND_SEPARATOR` settings. The latter two settings may also be
-dictated by the locale, which takes precedence.
+When set to ``True``, Django will format numbers using the
+:setting:`NUMBER_GROUPING` and :setting:`THOUSAND_SEPARATOR` settings. The
+latter two settings may also be dictated by the locale, which takes precedence.
See also :setting:`DECIMAL_SEPARATOR`, :setting:`NUMBER_GROUPING` and
:setting:`THOUSAND_SEPARATOR`.
@@ -2938,7 +2912,7 @@ When ``USE_TZ`` is False, Django will use naive datetimes in local time, except
when parsing ISO 8601 formatted strings, where timezone information will always
be retained if present.
-See also :setting:`TIME_ZONE`, :setting:`USE_I18N` and :setting:`USE_L10N`.
+See also :setting:`TIME_ZONE` and :setting:`USE_I18N`.
.. versionchanged:: 5.0
@@ -3005,8 +2979,8 @@ drilldown, the header for a given month displays the month and the year.
Different locales have different formats. For example, U.S. English would say
"January 2006," whereas another locale might say "2006/January."
-Note that if :setting:`USE_L10N` is set to ``True``, then the corresponding
-locale-dictated format has higher precedence and will be applied.
+Note that the corresponding locale-dictated format has higher precedence and
+will be applied instead.
See :tfilter:`allowed date format strings <date>`. See also
:setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT`
@@ -3730,7 +3704,6 @@ Globalization (``i18n``/``l10n``)
* :setting:`TIME_INPUT_FORMATS`
* :setting:`TIME_ZONE`
* :setting:`USE_I18N`
-* :setting:`USE_L10N`
* :setting:`USE_THOUSAND_SEPARATOR`
* :setting:`USE_TZ`
* :setting:`YEAR_MONTH_FORMAT`
diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt
index eb24a2854a..f866e865b5 100644
--- a/docs/ref/templates/builtins.txt
+++ b/docs/ref/templates/builtins.txt
@@ -1445,8 +1445,7 @@ The format passed can be one of the predefined ones :setting:`DATE_FORMAT`,
specifiers shown in the table above. Note that predefined formats may vary
depending on the current locale.
-Assuming that :setting:`USE_L10N` is ``True`` and :setting:`LANGUAGE_CODE` is,
-for example, ``"es"``, then for::
+Assuming that :setting:`LANGUAGE_CODE` is, for example, ``"es"``, then for::
{{ value|date:"SHORT_DATE_FORMAT" }}
@@ -2226,8 +2225,7 @@ This would display as "01h 23m".
Another example:
-Assuming that :setting:`USE_L10N` is ``True`` and :setting:`LANGUAGE_CODE` is,
-for example, ``"de"``, then for::
+Assuming that :setting:`LANGUAGE_CODE` is, for example, ``"de"``, then for::
{{ value|time:"TIME_FORMAT" }}
@@ -2586,8 +2584,7 @@ See :ref:`specifying-translation-strings-in-template-code`.
--------
This library provides control over the localization of values in templates.
-You only need to load the library using ``{% load l10n %}``, but you'll often
-set :setting:`USE_L10N` to ``True`` so that localization is active by default.
+You only need to load the library using ``{% load l10n %}``.
See :ref:`topic-l10n-templates`.
diff --git a/docs/releases/5.0.txt b/docs/releases/5.0.txt
index 011d01bec0..07ab33c439 100644
--- a/docs/releases/5.0.txt
+++ b/docs/releases/5.0.txt
@@ -274,6 +274,8 @@ to remove usage of these features.
``StringAgg`` aggregates no longer return ``[]``, ``[]``, and ``''``,
respectively, when there are no rows.
+* The ``USE_L10N`` setting is removed.
+
See :ref:`deprecated-features-4.1` for details on these changes, including how
to remove usage of these features.
diff --git a/docs/topics/i18n/formatting.txt b/docs/topics/i18n/formatting.txt
index b83c31e936..d58a52de30 100644
--- a/docs/topics/i18n/formatting.txt
+++ b/docs/topics/i18n/formatting.txt
@@ -9,12 +9,8 @@ Django's formatting system is capable of displaying dates, times and numbers in
templates using the format specified for the current
:term:`locale <locale name>`. It also handles localized input in forms.
-When it's enabled, two users accessing the same content may see dates, times and
-numbers formatted in different ways, depending on the formats for their current
-locale.
-
-The formatting system is enabled by default. To disable it, it's
-necessary to set :setting:`USE_L10N = False <USE_L10N>` in your settings file.
+Two users accessing the same content may see dates, times and numbers formatted
+in different ways, depending on the formats for their current locale.
.. note::
@@ -55,9 +51,8 @@ argument::
Controlling localization in templates
=====================================
-When you have enabled formatting with :setting:`USE_L10N`, Django
-will try to use a locale specific format whenever it outputs a value
-in a template.
+Django tries to use a locale specific format whenever it outputs a value in a
+template.
However, it may not always be appropriate to use localized values --
for example, if you're outputting JavaScript or XML that is designed
@@ -80,9 +75,6 @@ Template tags
Enables or disables localization of template variables in the
contained block.
-This tag allows a more fine grained control of localization than
-:setting:`USE_L10N`.
-
To activate or deactivate localization for a template block, use::
{% load l10n %}
@@ -95,11 +87,6 @@ To activate or deactivate localization for a template block, use::
{{ value }}
{% endlocalize %}
-.. note::
-
- The value of :setting:`USE_L10N` isn't respected inside of a
- ``{% localize %}`` block.
-
See :tfilter:`localize` and :tfilter:`unlocalize` for template filters that will
do the same job on a per-variable basis.
diff --git a/docs/topics/i18n/index.txt b/docs/topics/i18n/index.txt
index 77086c7f0f..d7b8087640 100644
--- a/docs/topics/i18n/index.txt
+++ b/docs/topics/i18n/index.txt
@@ -54,10 +54,9 @@ More details can be found in the `W3C Web Internationalization FAQ`_, the `Wikip
.. warning::
- Translation and formatting are controlled by :setting:`USE_I18N` and
- :setting:`USE_L10N` settings respectively. However, both features involve
- internationalization and localization. The names of the settings are an
- unfortunate result of Django's history.
+ Translation is controlled by the :setting:`USE_I18N` setting. However, it
+ involves internationalization and localization. The name of the setting is
+ an unfortunate result of Django's history.
Here are some other terms that will help us to handle a common language: