diff options
| author | Gary Wilson Jr <gary.wilson@gmail.com> | 2010-03-27 00:10:44 +0000 |
|---|---|---|
| committer | Gary Wilson Jr <gary.wilson@gmail.com> | 2010-03-27 00:10:44 +0000 |
| commit | 87e40f8daa0b6070d05299cbc6414007be62993b (patch) | |
| tree | df7774dbb01fecd401f6daf011347be32a2713a9 /docs/ref | |
| parent | 52e2e5cc9644e3deab04517789124022573f7a70 (diff) | |
[1.1.X] Fixed #13202 -- Documented required libraries for markup template tags, based on patch from steveed.
Backport of r12860 from trunk.
git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.1.X@12861 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/index.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/ref/contrib/index.txt b/docs/ref/contrib/index.txt index 24c74c3517..f8db69afd7 100644 --- a/docs/ref/contrib/index.txt +++ b/docs/ref/contrib/index.txt @@ -133,22 +133,27 @@ markup A collection of template filters that implement common markup languages: - * ``textile`` -- implements `Textile`_ - * ``markdown`` -- implements `Markdown`_ + * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_ + * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_ * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_ + -- requires `doc-utils`_ In each case, the filter expects formatted markup as a string and returns a string representing the marked-up text. For example, the ``textile`` filter converts text that is marked-up in Textile format to HTML. To activate these filters, add ``'django.contrib.markup'`` to your -:setting:`INSTALLED_APPS` setting. Once you've done that, use ``{% load markup %}`` in -a template, and you'll have access to these filters. For more documentation, -read the source code in django/contrib/markup/templatetags/markup.py. +:setting:`INSTALLED_APPS` setting. Once you've done that, use +``{% load markup %}`` in a template, and you'll have access to these filters. +For more documentation, read the source code in +:file:`django/contrib/markup/templatetags/markup.py`. .. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29 .. _Markdown: http://en.wikipedia.org/wiki/Markdown .. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText +.. _PyTextile: http://loopcore.com/python-textile/ +.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown +.. _doc-utils: http://docutils.sf.net/ redirects ========= |