mirror of https://github.com/django/django.git
Fixed #21101 -- Updated urlize documentation to mention email addresses
This commit is contained in:
parent
ec89e1725a
commit
39b49fd339
|
@ -2226,7 +2226,7 @@ If ``value`` is ``"http://www.example.org/"``, the output will be
|
||||||
urlize
|
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
|
This template tag works on links prefixed with ``http://``, ``https://``, or
|
||||||
``www.``. For example, ``http://goo.gl/aia1t`` will get converted but
|
``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 <a href="http://www.djangoproject.com"
|
``"Check out <a href="http://www.djangoproject.com"
|
||||||
rel="nofollow">www.djangoproject.com</a>"``.
|
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
|
The ``urlize`` filter also takes an optional parameter ``autoescape``. If
|
||||||
``autoescape`` is ``True``, the link text and URLs will be escaped using
|
``autoescape`` is ``True``, the link text and URLs will be escaped using
|
||||||
Django's built-in :tfilter:`escape` filter. The default value for
|
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
|
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.
|
longer than the given character limit.
|
||||||
|
|
||||||
**Argument:** Number of characters that link text should be truncated to,
|
**Argument:** Number of characters that link text should be truncated to,
|
||||||
|
|
Loading…
Reference in New Issue