p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #14912 -- Expanded documentation for the urlize template filter. Thanks to adamv for the draft patch. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@15086 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Gabriel Hurley 2010-12-28 22:53:28 +00:00
parent 40d1a478fd
commit 645323155b
1 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/ref/templates/builtins.txt
View File

@ -2072,38 +2072,54 @@ If ``value`` is ``"http://www.example.org/"``, the output will be
urlize urlize
~~~~~~ ~~~~~~
Converts URLs in plain text into clickable links. Converts URLs in text into clickable links.
Note that if ``urlize`` is applied to text that already contains HTML markup, Works on links beginning with ``http://``, ``https://``, or ``www.`` and
things won't work as expected. Apply this filter only to *plain* text. ending with ``.org``, ``.net`` or ``.com``. Links can have trailing punctuation
(periods, commas, close-parens) and leading punctuation (opening parens) and
``urlize`` will still do the right thing.
Links generated by ``urlize`` have a ``rel="nofollow"`` attribute added
to them.
For example:: For example::
{{ value|urlize }} {{ value|urlize }}
If ``value`` is ``"Check out www.djangoproject.com"``, the output will be If ``value`` is ``"Check out www.djangoproject.com"``, the output will be
``"Check out <a ``"Check out <a href="http://www.djangoproject.com"
href="http://www.djangoproject.com">www.djangoproject.com</a>"``. rel="nofollow">www.djangoproject.com</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
``autoescape`` is ``True``.
.. note::
If ``urlize`` is applied to text that already contains HTML markup,
things won't work as expected. Apply this filter only to plain text.
.. templatefilter:: urlizetrunc .. templatefilter:: urlizetrunc
urlizetrunc urlizetrunc
~~~~~~~~~~~ ~~~~~~~~~~~
Converts URLs into clickable links, truncating URLs longer than the given Converts URLs into clickable links just like urlize_, but truncates URLs
character limit. longer than the given character limit.
As with urlize_, this filter should only be applied to *plain* text. **Argument:** Number of characters that link text should be truncated to,
including the ellipsis that's added if truncation is necessary.
**Argument:** Length to truncate URLs to
For example:: For example::
{{ value|urlizetrunc:15 }} {{ value|urlizetrunc:15 }}
If ``value`` is ``"Check out www.djangoproject.com"``, the output would be If ``value`` is ``"Check out www.djangoproject.com"``, the output would be
``'Check out <a ``'Check out <a href="http://www.djangoproject.com"
href="http://www.djangoproject.com">www.djangopr...</a>'``. rel="nofollow">www.djangopr...</a>'``.
As with urlize_, this filter should only be applied to plain text.
.. templatefilter:: wordcount .. templatefilter:: wordcount