Changeset 7754 for django/trunk/docs/cache.txt

Timestamp:

06/25/08 23:54:10 (4 months ago)

Author:

adrian

Message:

Fixed #6201 -- Improved the {% cache %} template tag to allow the timeout to be a template variable. Inspired by the patch by zz and edrik

Files:

• django/trunk/docs/cache.txt (modified) (1 diff)

django/trunk/docs/cache.txt

@@ -337 +337 @@
-Simply pass as many arguments to ``{% cache %}`` as you need.
-
+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::
+
+    {% cache 600 sidebar %} ... {% endcache %}
+    {% cache my_timeout sidebar %} ... {% endcache %}
+
+This feature is useful in avoiding repetition in templates. You can set the
+timeout in a variable, in one place, and just reuse that value.
+
-The low-level cache API
-=======================