Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[1.2.X] Refactored markup documentation to give it it's own home.

Backport of r13647 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@13649 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit c868c368eb7d84dfb75f59ba5cf99a601ac077f4 1 parent 38e9ca1
Russell Keith-Magee authored August 28, 2010
37  docs/ref/contrib/index.txt
@@ -33,6 +33,7 @@ those packages have.
33 33
    gis/index
34 34
    humanize
35 35
    localflavor
  36
+   markup
36 37
    messages
37 38
    redirects
38 39
    sitemaps
@@ -134,44 +135,12 @@ contains a ``USZipCodeField`` that you can use to validate U.S. zip codes.
134 135
 
135 136
 See the :doc:`localflavor documentation </ref/contrib/localflavor>`.
136 137
 
137  
-.. _ref-contrib-markup:
138  
-
139 138
 markup
140 139
 ======
141 140
 
142  
-A collection of template filters that implement common markup languages:
143  
-
144  
-    * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
145  
-    * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
146  
-    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
147  
-      -- requires `doc-utils`_
148  
-
149  
-In each case, the filter expects formatted markup as a string and returns a
150  
-string representing the marked-up text. For example, the ``textile`` filter
151  
-converts text that is marked-up in Textile format to HTML.
152  
-
153  
-To activate these filters, add ``'django.contrib.markup'`` to your
154  
-:setting:`INSTALLED_APPS` setting. Once you've done that, use
155  
-``{% load markup %}`` in a template, and you'll have access to these filters.
156  
-For more documentation, read the source code in
157  
-:file:`django/contrib/markup/templatetags/markup.py`.
158  
-
159  
-.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
160  
-.. _Markdown: http://en.wikipedia.org/wiki/Markdown
161  
-.. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
162  
-.. _PyTextile: http://loopcore.com/python-textile/
163  
-.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
164  
-.. _doc-utils: http://docutils.sf.net/
165  
-
166  
-ReStructured Text
167  
------------------
168  
-
169  
-When using the ``restructuredtext`` markup filter you can define a
170  
-:setting:`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your django settings to override
171  
-the default writer settings. See the `restructuredtext writer settings`_ for
172  
-details on what these settings are.
  141
+A collection of template filters that implement common markup languages
173 142
 
174  
-.. _restructuredtext writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
  143
+See the :doc:`markup documentation </ref/contrib/markup>`.
175 144
 
176 145
 messages
177 146
 ========
42  docs/ref/contrib/markup.txt
... ...
@@ -0,0 +1,42 @@
  1
+=====================
  2
+django.contrib.markup
  3
+=====================
  4
+
  5
+.. module:: django.contrib.markup
  6
+   :synopsis: A collection of template filters that implement common markup languages.
  7
+
  8
+Django provides template filters that implement the following markup
  9
+languages:
  10
+
  11
+    * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
  12
+    * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
  13
+    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
  14
+      -- requires `doc-utils`_
  15
+
  16
+In each case, the filter expects formatted markup as a string and
  17
+returns a string representing the marked-up text. For example, the
  18
+``textile`` filter converts text that is marked-up in Textile format
  19
+to HTML.
  20
+
  21
+To activate these filters, add ``'django.contrib.markup'`` to your
  22
+:setting:`INSTALLED_APPS` setting. Once you've done that, use
  23
+``{% load markup %}`` in a template, and you'll have access to these filters.
  24
+For more documentation, read the source code in
  25
+:file:`django/contrib/markup/templatetags/markup.py`.
  26
+
  27
+.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
  28
+.. _Markdown: http://en.wikipedia.org/wiki/Markdown
  29
+.. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
  30
+.. _PyTextile: http://loopcore.com/python-textile/
  31
+.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
  32
+.. _doc-utils: http://docutils.sf.net/
  33
+
  34
+ReStructured Text
  35
+-----------------
  36
+
  37
+When using the ``restructuredtext`` markup filter you can define a
  38
+:setting:`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your django settings to
  39
+override the default writer settings. See the `restructuredtext writer
  40
+settings`_ for details on what these settings are.
  41
+
  42
+.. _restructuredtext writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
2  docs/ref/templates/builtins.txt
@@ -2071,7 +2071,7 @@ A collection of template filters that implement these common markup languages:
2071 2071
     * Markdown
2072 2072
     * ReST (ReStructured Text)
2073 2073
 
2074  
-See :ref:`ref-contrib-markup`.
  2074
+See the :doc:`markup documentation </ref/contrib/markup>`.
2075 2075
 
2076 2076
 django.contrib.webdesign
2077 2077
 ~~~~~~~~~~~~~~~~~~~~~~~~

0 notes on commit c868c36

Please sign in to comment.
Something went wrong with that request. Please try again.