Browse files

[1.2.X] Fixed #13452 - Document that regroup can be used with any tem…

…plate lookup. Thanks shacker for the suggestion and draft patch.

Backport of r15108 from trunk.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
timgraham committed Dec 29, 2010
1 parent 863240e commit 6c51b80c04358873b05dd87d36d33ddbf3b1447f
Showing with 23 additions and 2 deletions.
  1. +23 −2 docs/ref/templates/builtins.txt
@@ -761,6 +761,27 @@ filter, if your data is in a list of dictionaries::
{% regroup people|dictsort:"gender" by gender as gender_list %}
+Grouping on other properties
+Any valid template lookup is a legal grouping attribute for the regroup
+tag, including methods, attributes, dictionary keys and list items. For
+example, if the "gender" field is a foreign key to a class with
+an attribute "description," you could use::
+ {% regroup people by gender.description as gender_list %}
+Or, if ``gender`` is a field with ``choices``, it will have a
+:meth:`~django.db.models.Model.get_FOO_display` method available as an
+attribute, allowing you to group on the display string rather than the
+``choices`` key::
+ {% regroup people by get_gender_display as gender_list %}
+``{{ gender.grouper }}`` will now display the value fields from the
+``choices`` set rather than the keys.
.. templatetag:: spaceless
@@ -1958,7 +1979,7 @@ urlize
Converts URLs in text into clickable links.
-Works on links beginning with ``http://``, ``https://``, or ``www.`` and
+Works on links beginning with ``http://``, ``https://``, or ``www.`` and
ending with ``.org``, ``.net`` or ``.com``. Links can have trailing punctuation
(periods, commas, close-parens) and leading punctuation (opening parens) and
``urlize`` will still do the right thing.
@@ -1992,7 +2013,7 @@ urlizetrunc
Converts URLs into clickable links just like urlize_, but truncates URLs
longer than the given character limit.
-**Argument:** Number of characters that link text should be truncated to,
+**Argument:** Number of characters that link text should be truncated to,
including the ellipsis that's added if truncation is necessary.
For example::

0 comments on commit 6c51b80

Please sign in to comment.