Browse files

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

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4474 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 766e339 commit 1aa1c4672cf7213f1073a5ab5f7c1ac8bc78d19f @malcolmt malcolmt committed Feb 10, 2007
Showing with 10 additions and 0 deletions.
  1. +10 −0 docs/templates.txt
View
10 docs/templates.txt
@@ -1133,6 +1133,16 @@ Truncates a string after a certain number of words.
**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
~~~~~~~~~~~~~~

0 comments on commit 1aa1c46

Please sign in to comment.