It's a modification of the standard "for" tag and i have kept the counter, counter0, first and last variables, only this time they are not attributes to forloop, but rather to recurseloop. Check the docstring for more info.

For example, if you need to print comments that have other comments as replies, you would want the comments to appear one below the other, but the replies to be indented a bit. Let's say 20 pixels per level. So the code would be:

{% load file_that_contains_recurse_tag %}
{% recurse comment in comments children="replies" indent=(0,20) %}
  <div style='margin-left:{{indent}}px;'>
    {{ comment.text }}
  </div>
{% endrecurse %}

This tag will expect a list of comments (top-level) that have a property named 'replies' which contain other comments.

indent is an argument that will start with the float value of 0 and get increased by 20 on each depth level of the recursion. You can pass as many variables like indent as you like. They must be in the form

name=(float,float)

or strings will also work but must be enclosed in quotes

name=("string","string")

Caveat: You must not leave blank spaces between the equal signs when assigning children and additional incremented arguments. I will fix this later.

A second scenario is when you need the parent element to contain the children, like in unordered/ordered lists. In that case you can use the {% yield %} tag inside the recurse block. This tag will output the HTML between the recurse and endrecurse tags if there are any children in the current iteration item, or it will output nothing if there are no children.

{% recurse comment in comments children="replies" indent=(0,20) %}
<div style='margin-left:20px;'>
  {{ comment.text }}
  {% yield %}
  </div>
{% endrecurse %}

The yield tag (as for now) can only be used directly inside the recurse block, much like the {% else %} tag can only be used directly inside the if-endif block. This means that you can't make code like

{% recurse comment in comments children="replies" indent=(0,20) %}
<div style='margin-left:{{indent}}px;'>
  ({{ comment.text }})
</div>
  {% if cond %}
    {% yield %}
  {% endif %}
{% endrecurse %}

This will fail with an invalid block tag exception. You can check the docstring of the do_recurse function inside the code for more info. Also, you may want to check this code for errors since I just wrote it today, and haven't had much time to test it.

Download and comment on any errors you find :)