Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[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
@freakboy3742 freakboy3742 authored
View
37 docs/ref/contrib/index.txt
@@ -33,6 +33,7 @@ those packages have.
gis/index
humanize
localflavor
+ markup
messages
redirects
sitemaps
@@ -134,44 +135,12 @@ contains a ``USZipCodeField`` that you can use to validate U.S. zip codes.
See the :doc:`localflavor documentation </ref/contrib/localflavor>`.
-.. _ref-contrib-markup:
-
markup
======
-A collection of template filters that implement common markup languages:
-
- * ``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
-: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/
-
-ReStructured Text
------------------
-
-When using the ``restructuredtext`` markup filter you can define a
-:setting:`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your django settings to override
-the default writer settings. See the `restructuredtext writer settings`_ for
-details on what these settings are.
+A collection of template filters that implement common markup languages
-.. _restructuredtext writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
+See the :doc:`markup documentation </ref/contrib/markup>`.
messages
========
View
42 docs/ref/contrib/markup.txt
@@ -0,0 +1,42 @@
+=====================
+django.contrib.markup
+=====================
+
+.. module:: django.contrib.markup
+ :synopsis: A collection of template filters that implement common markup languages.
+
+Django provides template filters that implement the following markup
+languages:
+
+ * ``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
+: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/
+
+ReStructured Text
+-----------------
+
+When using the ``restructuredtext`` markup filter you can define a
+:setting:`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your django settings to
+override the default writer settings. See the `restructuredtext writer
+settings`_ for details on what these settings are.
+
+.. _restructuredtext writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
View
2  docs/ref/templates/builtins.txt
@@ -2071,7 +2071,7 @@ A collection of template filters that implement these common markup languages:
* Markdown
* ReST (ReStructured Text)
-See :ref:`ref-contrib-markup`.
+See the :doc:`markup documentation </ref/contrib/markup>`.
django.contrib.webdesign
~~~~~~~~~~~~~~~~~~~~~~~~
Please sign in to comment.
Something went wrong with that request. Please try again.