From 23e85ef25fd56de439337df28227a87080046156 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Sat, 28 Aug 2010 02:40:17 +0000 Subject: [PATCH] Refactored markup documentation to give it it's own home. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13647 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/contrib/index.txt | 37 +++-------------------------- docs/ref/contrib/markup.txt | 42 +++++++++++++++++++++++++++++++++ docs/ref/templates/builtins.txt | 2 +- 3 files changed, 46 insertions(+), 35 deletions(-) create mode 100644 docs/ref/contrib/markup.txt diff --git a/docs/ref/contrib/index.txt b/docs/ref/contrib/index.txt index 177da89edd..90edf72c94 100644 --- a/docs/ref/contrib/index.txt +++ b/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-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`_ - -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 +See the :doc:`markup documentation `. messages ======== diff --git a/docs/ref/contrib/markup.txt b/docs/ref/contrib/markup.txt new file mode 100644 index 0000000000..f2c43fe25f --- /dev/null +++ b/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 diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index ac7fa576a1..b5ce71e321 100644 --- a/docs/ref/templates/builtins.txt +++ b/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 `. django.contrib.webdesign ~~~~~~~~~~~~~~~~~~~~~~~~