Author: jezdez
Date: 2010-03-15 07:16:37 -0500 (Mon, 15 Mar 2010)
New Revision: 12787
Modified:
django/trunk/docs/topics/cache.txt
django/trunk/docs/topics/i18n/internationalization.txt
Log:
Fixed #13014 - Added section about how to use the language code with fragement
caching. Thanks for the initial patch, fgutierrez.
Modified: django/trunk/docs/topics/cache.txt
===================================================================
--- django/trunk/docs/topics/cache.txt 2010-03-15 12:16:21 UTC (rev 12786)
+++ django/trunk/docs/topics/cache.txt 2010-03-15 12:16:37 UTC (rev 12787)
@@ -320,6 +320,8 @@
the ``never_cache`` decorator). See the `using other headers`__ section for
more on these decorators.
+.. _i18n-cache-key:
+
.. versionadded:: 1.2
If :setting:`USE_I18N` is set to ``True`` then the generated cache key will
@@ -413,8 +415,10 @@
The ``{% cache %}`` template tag caches the contents of the block for a given
amount of time. It takes at least two arguments: the cache timeout, in seconds,
-and the name to give the cache fragment. For example::
+and the name to give the cache fragment. For example:
+.. code-block:: html+django
+
{% load cache %}
{% cache 500 sidebar %}
.. sidebar ..
@@ -424,8 +428,10 @@
some dynamic data that appears inside the fragment. For example, you might
want a
separate cached copy of the sidebar used in the previous example for every user
of your site. Do this by passing additional arguments to the ``{% cache %}``
-template tag to uniquely identify the cache fragment::
+template tag to uniquely identify the cache fragment:
+.. code-block:: html+django
+
{% load cache %}
{% cache 500 sidebar request.user.username %}
.. sidebar for logged in user ..
@@ -434,11 +440,30 @@
It's perfectly fine to specify more than one argument to identify the fragment.
Simply pass as many arguments to ``{% cache %}`` as you need.
+If :setting:`USE_I18N` is set to ``True`` the per-site middleware cache will
+:ref:`respect the active language<i18n-cache-key>`. For the ``cache`` template
+tag you could use one of the
+:ref:`translation-specific variables<template-translation-vars>` available in
+templates to archieve the same result:
+
+.. code-block:: html+django
+
+ {% load i18n %}
+ {% load cache %}
+
+ {% get_current_language as LANGUAGE_CODE %}
+
+ {% cache 600 welcome LANGUAGE_CODE %}
+ {% trans "Welcome to example.com" %}
+ {% endcache %}
+
The cache timeout can be a template variable, as long as the template variable
resolves to an integer value. For example, if the template variable
``my_timeout`` is set to the value ``600``, then the following two examples are
-equivalent::
+equivalent:
+.. code-block:: html+django
+
{% cache 600 sidebar %} ... {% endcache %}
{% cache my_timeout sidebar %} ... {% endcache %}
@@ -448,6 +473,8 @@
The low-level cache API
=======================
+.. highlight:: python
+
Sometimes, caching an entire rendered page doesn't gain you very much and is,
in fact, inconvenient overkill.
Modified: django/trunk/docs/topics/i18n/internationalization.txt
===================================================================
--- django/trunk/docs/topics/i18n/internationalization.txt 2010-03-15
12:16:21 UTC (rev 12786)
+++ django/trunk/docs/topics/i18n/internationalization.txt 2010-03-15
12:16:37 UTC (rev 12787)
@@ -385,6 +385,8 @@
to an ``ungettext`` call. This means the same :ref:`notes regarding ungettext
variables <pluralization-var-notes>` apply.
+.. _template-translation-vars:
+
Each ``RequestContext`` has access to three translation-specific variables:
* ``LANGUAGES`` is a list of tuples in which the first element is the
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-upda...@googlegroups.com.
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
