Changeset 4474

Timestamp:

02/09/07 23:22:12 (2 years ago)

Author:

mtredinnick

Message:

Added some documentation for truncatewords_html (added in [4468]).

Files:

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

django/trunk/docs/templates.txt

@@ -1134 +1134 @@
-**Argument:** Number of words to truncate after
-
+truncatewords_html
+~~~~~~~~~~~~~~~~~~
+
+Similar to ``truncatewords``, except that it is aware of HTML tags. Any tags
+that are opened in the string and not closed before the truncation point, are
+closed immediately after the truncation.
+
+This is less efficient than ``truncatewords``, so should only be used when it
+is being passed HTML text.
+
-unordered_list
-~~~~~~~~~~~~~~