Skip to content

Commit

Permalink
Fixed #21101 -- Updated urlize documentation to mention email addresses
Browse files Browse the repository at this point in the history
  • Loading branch information
goetzb authored and timgraham committed Sep 13, 2013
1 parent ec89e17 commit 39b49fd
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/ref/templates/builtins.txt
Expand Up @@ -2226,7 +2226,7 @@ If ``value`` is ``"http://www.example.org/"``, the output will be
urlize
^^^^^^

Converts URLs in text into clickable links.
Converts URLs and email addresses in text into clickable links.

This template tag works on links prefixed with ``http://``, ``https://``, or
``www.``. For example, ``http://goo.gl/aia1t`` will get converted but
Expand All @@ -2250,6 +2250,11 @@ If ``value`` is ``"Check out www.djangoproject.com"``, the output will be
``"Check out <a href="http://www.djangoproject.com"
rel="nofollow">www.djangoproject.com</a>"``.

In addition to web links, ``urlize`` also converts email addresses into
``mailto:`` links. If ``value`` is
``"Send questions to foo@example.com"``, the output will be
``"Send questions to <a href="mailto:foo@example.com">foo@example</a>"``.

The ``urlize`` filter also takes an optional parameter ``autoescape``. If
``autoescape`` is ``True``, the link text and URLs will be escaped using
Django's built-in :tfilter:`escape` filter. The default value for
Expand All @@ -2265,7 +2270,7 @@ Django's built-in :tfilter:`escape` filter. The default value for
urlizetrunc
^^^^^^^^^^^

Converts URLs into clickable links just like urlize_, but truncates URLs
Converts URLs and email addresses 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,
Expand Down

0 comments on commit 39b49fd

Please sign in to comment.