Code

Ticket #13202: 13202.diff

File 13202.diff, 1.6 KB (added by steveed, 4 years ago)
Line 
1Index: docs/ref/contrib/index.txt
2===================================================================
3--- docs/ref/contrib/index.txt  (revision 12855)
4+++ docs/ref/contrib/index.txt  (working copy)
5@@ -134,13 +134,15 @@
6 
7 A collection of template filters that implement common markup languages:
8 
9-    * ``textile`` -- implements `Textile`_
10-    * ``markdown`` -- implements `Markdown`_
11-    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
12+    * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
13+    * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
14+    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_ -- requires `doc-utils`_
15 
16 In each case, the filter expects formatted markup as a string and returns a
17 string representing the marked-up text. For example, the ``textile`` filter
18-converts text that is marked-up in Textile format to HTML.
19+converts text that is marked-up in Textile format to HTML. If the required
20+library is not installed, the filter will silently fail and return the
21+un-marked-up text.
22 
23 To activate these filters, add ``'django.contrib.markup'`` to your
24 :setting:`INSTALLED_APPS` setting. Once you've done that, use ``{% load markup %}`` in
25@@ -150,6 +152,9 @@
26 .. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
27 .. _Markdown: http://en.wikipedia.org/wiki/Markdown
28 .. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
29+.. _PyTextile: http://loopcore.com/python-textile/
30+.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
31+.. _doc-utils: http://docutils.sf.net/
32 
33 messages
34 ========