documented recursive loops

--HG--
branch : trunk

diff --git a/docs/templates.rst b/docs/templates.rst
index ea19e2d55abcdd525235e8a972e0a73854394514..90d4099da1498631c35890802b4aa22d4f7e2105 100644 (file)
--- a/docs/templates.rst
+++ b/docs/templates.rst
@@ -455,6 +455,22 @@ by using `else`::
     {% endif %}
     </ul>
 
+It is also possible to use loops recursively.  This is useful if you are
+dealing with recursive data such as sitemaps.  To use loops recursively you
+basically have to add the `recursive` modifier to the loop definition and
+call the `loop` variable with the new iterable where you want to recurse.
+
+The following example implements a sitemap with recursive loops::
+
+    <ul class="sitemap">
+    {%- for item in sitemap recursive %}
+        <li><a href="{{ item.href|e }}">{{ item.title }}</a>
+        {%- if item.children -%}
+            <ul class="submenu">{{ loop(item.children) }}</ul>
+        {%- endif %}</li>
+    {%- endfor %}
+    </ul>
+
 
 If
 ~~