diff options
| author | Goetz <goetz.buerkle@gmail.com> | 2013-09-13 16:45:42 +0100 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-09-13 12:42:47 -0400 |
| commit | dbc2e8eb73ca15fd3f2b9c5ddfa69651330bcead (patch) | |
| tree | fe70eb43adaf7f5a60242c3715cc61f40fa91ee7 /docs/ref | |
| parent | 61de57260b4b2bb54fe3c494d104b85e957c9be2 (diff) | |
[1.5.x] Fixed #21101 -- Updated urlize documentation to mention email addresses
Backport of 39b49fd339 from master
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/templates/builtins.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index cd85c29762..1572b15604 100644 --- a/docs/ref/templates/builtins.txt +++ b/docs/ref/templates/builtins.txt @@ -2164,7 +2164,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 @@ -2193,6 +2193,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 @@ -2208,7 +2213,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, |