Document using LANGUAGE_CODE with the cache template tag

[yml]

Issue:
The cache templatetag does not take into account the Language (i18n).

Solution:
The cache templatetag[1] should be updated to use the new _i18n_cache_key_suffix[2]. Given context in which this code is evaluated the request is not required :
cache_key = _i18n_cache_key_suffix(request=None, cache_key):

This is in fact a follow up this ticket : #5691 which reported a similar issue with the cache middleware. the infrastructure for this change has been added in r12624 and r12546

[1]​http://code.djangoproject.com/browser/django/trunk/django/templatetags/cache.py#L28
[2] ​http://code.djangoproject.com/browser/django/trunk/django/utils/cache.py#L137

[Chris Beaven]

I think that it makes sense to achieve parity between decorator and template tag caching before 1.2

[Chris Beaven]

Yann brought up the point that maybe a user should be told to just do this manually by passing the locale as a cache argument.

Some short docs should be added to explain either the difference in behaviour or the parity.

[Jannis Leidel]

IMO, we should simply mention in the docs that this works well:

{% cache 60 welcome request.LANGUAGE_CODE %}
    {% trans "Welcome to zombo.com" %}
{% endcache %}

It's not exactly the same as the cache/middleware approach, but that's true for fragment caching anyway -- it's built to be flexible in contrast to out of the box caching of the middleware/decorator mechanism.

[Chris Beaven]

You'd also want to mention that they'd have to pass request in the context, or use the request context processor & a requestcontext.

But sure, if that's enough then someone can just write some nice docs :)

[Jacob]

Doesn't the i18n context processor put LANGUAGE_CODEin the context? Seems to me that's the right approach -- "explicit is better than implicit". Any reason we should do anything more than a doc addition?

[Chris Beaven]

Good point, Jacob. Definitely just a documentation job.

[Chris Beaven]

The patch doesn't address the decision made to just document this behavior, Mr Anonymous.

[fgutierrez@…]

Just added a doc patch. Hope it is correct.

[Jannis Leidel]

(In [12787]) Fixed #13014 - Added section about how to use the language code with fragement caching. Thanks for the initial patch, fgutierrez.

[Jacob]

Milestone 1.2 deleted