summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2007-02-10 05:22:12 +0000
committerMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2007-02-10 05:22:12 +0000
commit1aa1c4672cf7213f1073a5ab5f7c1ac8bc78d19f (patch)
tree9f25d39a42008f87b45f0360e48eb57502d80693 /docs
parent766e339666b77225fca09c7124b863aa81e56e56 (diff)
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
Diffstat (limited to 'docs')
-rw-r--r--docs/templates.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/templates.txt b/docs/templates.txt
index 9f8fe446b4..a3d60c5400 100644
--- a/docs/templates.txt
+++ b/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
~~~~~~~~~~~~~~