Author: russellm
Date: 2010-08-27 21:44:24 -0500 (Fri, 27 Aug 2010)
New Revision: 13649
Added:
django/branches/releases/1.2.X/docs/ref/contrib/markup.txt
Modified:
django/branches/releases/1.2.X/docs/ref/contrib/index.txt
django/branches/releases/1.2.X/docs/ref/templates/builtins.txt
Log:
[1.2.X] Refactored markup documentation to give it it's own home.
Backport of r13647 from trunk.
Modified: django/branches/releases/1.2.X/docs/ref/contrib/index.txt
===================================================================
--- django/branches/releases/1.2.X/docs/ref/contrib/index.txt 2010-08-28
02:40:57 UTC (rev 13648)
+++ django/branches/releases/1.2.X/docs/ref/contrib/index.txt 2010-08-28
02:44:24 UTC (rev 13649)
@@ -33,6 +33,7 @@
gis/index
humanize
localflavor
+ markup
messages
redirects
sitemaps
@@ -134,45 +135,13 @@
See the :doc:`localflavor documentation </ref/contrib/localflavor>`.
-.. _ref-contrib-markup:
-
markup
======
-A collection of template filters that implement common markup languages:
+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`_
+See the :doc:`markup documentation </ref/contrib/markup>`.
-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
-
messages
========
Added: django/branches/releases/1.2.X/docs/ref/contrib/markup.txt
===================================================================
--- django/branches/releases/1.2.X/docs/ref/contrib/markup.txt
(rev 0)
+++ django/branches/releases/1.2.X/docs/ref/contrib/markup.txt 2010-08-28
02:44:24 UTC (rev 13649)
@@ -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
Modified: django/branches/releases/1.2.X/docs/ref/templates/builtins.txt
===================================================================
--- django/branches/releases/1.2.X/docs/ref/templates/builtins.txt
2010-08-28 02:40:57 UTC (rev 13648)
+++ django/branches/releases/1.2.X/docs/ref/templates/builtins.txt
2010-08-28 02:44:24 UTC (rev 13649)
@@ -2071,7 +2071,7 @@
* Markdown
* ReST (ReStructured Text)
-See :ref:`ref-contrib-markup`.
+See the :doc:`markup documentation </ref/contrib/markup>`.
django.contrib.webdesign
~~~~~~~~~~~~~~~~~~~~~~~~
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
