diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index 9d096e44b3..cc1ca46e9f 100644 --- a/docs/ref/templates/builtins.txt +++ b/docs/ref/templates/builtins.txt @@ -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 @@ -2250,6 +2250,11 @@ If ``value`` is ``"Check out www.djangoproject.com"``, the output will be ``"Check out www.djangoproject.com"``. +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 foo@example"``. + 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 @@ -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,