summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdrian Holovaty <adrian@holovaty.com>2007-03-27 22:18:52 +0000
committerAdrian Holovaty <adrian@holovaty.com>2007-03-27 22:18:52 +0000
commit9a2a9a9fe8eb93ecf1cb6ef64c0fd90be2a05216 (patch)
treeaace30c556b8acb762d00152426632ab9bdcca8f /docs
parent932928a1e2f48cacc94c0052626bcf6971ac3523 (diff)
Fixed #3781 -- Improved docs/add_ons.txt to clarify use of contrib apps. Thanks, Simon G.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@4833 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/add_ons.txt24
1 files changed, 19 insertions, 5 deletions
diff --git a/docs/add_ons.txt b/docs/add_ons.txt
index 9809cf46f8..b92ae0bd17 100644
--- a/docs/add_ons.txt
+++ b/docs/add_ons.txt
@@ -9,6 +9,13 @@ problems.
This code lives in ``django/contrib`` in the Django distribution. Here's a
rundown of the packages in ``contrib``:
+.. admonition:: Note
+
+ For most of these add-ons -- specifically, the add-ons that include either
+ models or template tags -- you'll need to add the package name (e.g.,
+ ``'django.contrib.admin'``) to your ``INSTALLED_APPS`` setting and re-run
+ ``manage.py syncdb``.
+
.. _"batteries included" philosophy: http://docs.python.org/tut/node12.html#batteries-included
admin
@@ -147,13 +154,20 @@ contains a ``USZipCodeField`` that you can use to validate U.S. zip codes.
markup
======
-A collection of template filters that implement these common markup languages:
+A collection of template filters that implement common markup languages:
+
+ * ``textile`` -- implements `Textile`_
+ * ``markdown`` -- implements `Markdown`_
+ * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
- * `Textile`_
- * `Markdown`_
- * `ReST (ReStructured Text)`_
+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.
-For documentation, read the source code in django/contrib/markup/templatetags/markup.py.
+To activate these filters, add ``'django.contrib.markup'`` to your
+``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 django/contrib/markup/templatetags/markup.py.
.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
.. _Markdown: http://en.wikipedia.org/wiki/Markdown