summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarc Tamlyn <marc.tamlyn@gmail.com>2012-08-18 13:53:22 +0100
committerAndrew Godwin <andrew@aeracode.org>2012-08-18 15:07:21 +0100
commit212b9826bdda5c3c2eb680e6f9c5b046b4172300 (patch)
tree238d889428e40564b78e9c9bd3139ec641f48589 /docs
parent58683e9c82d6e7c5fbb7acef79eef9408b776ab0 (diff)
Fixed #14516 -- Extract methods from removetags and slugify template filters
Patch by @jphalip updated to apply, documentation and release notes added. I've documented strip_tags as well as remove_tags as the difference between the two wouldn't be immediately obvious.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/utils.txt45
-rw-r--r--docs/releases/1.5.txt4
2 files changed, 49 insertions, 0 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 20775fcc81..775d70738b 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -486,6 +486,33 @@ escaping HTML.
through :func:`conditional_escape` which (ultimately) calls
:func:`~django.utils.encoding.force_text` on the values.
+.. function:: strip_tags(value)
+
+ Removes anything that looks like an html tag from the string, that is
+ anything contained within ``<>``.
+
+ For example::
+
+ strip_tags(value)
+
+ If ``value`` is ``"<b>Joel</b> <button>is</button> a <span>slug</span>"`` the
+ return value will be ``"Joel is a slug"``.
+
+.. function:: remove_tags(value, tags)
+
+ Removes a list of [X]HTML tag names from the output.
+
+ For example::
+
+ remove_tags(value, ["b", "span"])
+
+ If ``value`` is ``"<b>Joel</b> <button>is</button> a <span>slug</span>"`` the
+ return value will be ``"Joel <button>is</button> a slug"``.
+
+ Note that this filter is case-sensitive.
+
+ If ``value`` is ``"<B>Joel</B> <button>is</button> a <span>slug</span>"`` the
+ return value will be ``"<B>Joel</B> <button>is</button> a slug"``.
.. _str.format: http://docs.python.org/library/stdtypes.html#str.format
@@ -599,6 +626,24 @@ appropriate entities.
Can be called multiple times on a single string (the resulting escaping is
only applied once).
+``django.utils.text``
+=====================
+
+.. module:: django.utils.text
+ :synopsis: Text manipulation.
+
+.. function:: slugify
+
+ Converts to lowercase, removes non-word characters (alphanumerics and
+ underscores) and converts spaces to hyphens. Also strips leading and trailing
+ whitespace.
+
+ For example::
+
+ slugify(value)
+
+ If ``value`` is ``"Joel is a slug"``, the output will be ``"joel-is-a-slug"``.
+
``django.utils.translation``
============================
diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt
index 5f27b7ccbb..29cbd45c49 100644
--- a/docs/releases/1.5.txt
+++ b/docs/releases/1.5.txt
@@ -267,6 +267,10 @@ Miscellaneous
* :func:`~django.utils.http.int_to_base36` properly raises a :exc:`TypeError`
instead of :exc:`ValueError` for non-integer inputs.
+* The ``slugify`` template filter is now available as a standard python
+ function at :func:`django.utils.text.slugify`. Similarly, ``remove_tags`` is
+ available at :func:`django.utils.html.remove_tags`.
+
Features deprecated in 1.5
==========================