Ticket #13202: 13202.diff

File 13202.diff, 1.6 KB (added by steveed, 5 years ago)
  • docs/ref/contrib/index.txt

     
    134134
    135135A collection of template filters that implement common markup languages:
    136136
    137     * ``textile`` -- implements `Textile`_
    138     * ``markdown`` -- implements `Markdown`_
    139     * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
     137    * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
     138    * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
     139    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_ -- requires `doc-utils`_
    140140
    141141In each case, the filter expects formatted markup as a string and returns a
    142142string representing the marked-up text. For example, the ``textile`` filter
    143 converts text that is marked-up in Textile format to HTML.
     143converts text that is marked-up in Textile format to HTML. If the required
     144library is not installed, the filter will silently fail and return the
     145un-marked-up text.
    144146
    145147To activate these filters, add ``'django.contrib.markup'`` to your
    146148:setting:`INSTALLED_APPS` setting. Once you've done that, use ``{% load markup %}`` in
     
    150152.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
    151153.. _Markdown: http://en.wikipedia.org/wiki/Markdown
    152154.. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
     155.. _PyTextile: http://loopcore.com/python-textile/
     156.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
     157.. _doc-utils: http://docutils.sf.net/
    153158
    154159messages
    155160========
Back to Top