Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #3781 -- Improved docs/add_ons.txt to clarify use of contrib ap…

…ps. Thanks, Simon G.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4833 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 9a2a9a9fe8eb93ecf1cb6ef64c0fd90be2a05216 1 parent 932928a
Adrian Holovaty authored March 27, 2007

Showing 1 changed file with 19 additions and 5 deletions. Show diff stats Hide diff stats

  1. 24  docs/add_ons.txt
24  docs/add_ons.txt
@@ -9,6 +9,13 @@ problems.
9 9
 This code lives in ``django/contrib`` in the Django distribution. Here's a
10 10
 rundown of the packages in ``contrib``:
11 11
 
  12
+.. admonition:: Note
  13
+
  14
+    For most of these add-ons -- specifically, the add-ons that include either
  15
+    models or template tags -- you'll need to add the package name (e.g.,
  16
+    ``'django.contrib.admin'``) to your ``INSTALLED_APPS`` setting and re-run
  17
+    ``manage.py syncdb``.
  18
+
12 19
 .. _"batteries included" philosophy: http://docs.python.org/tut/node12.html#batteries-included
13 20
 
14 21
 admin
@@ -147,13 +154,20 @@ contains a ``USZipCodeField`` that you can use to validate U.S. zip codes.
147 154
 markup
148 155
 ======
149 156
 
150  
-A collection of template filters that implement these common markup languages:
  157
+A collection of template filters that implement common markup languages:
  158
+
  159
+    * ``textile`` -- implements `Textile`_
  160
+    * ``markdown`` -- implements `Markdown`_
  161
+    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
151 162
 
152  
-    * `Textile`_
153  
-    * `Markdown`_
154  
-    * `ReST (ReStructured Text)`_
  163
+In each case, the filter expects formatted markup as a string and returns a
  164
+string representing the marked-up text. For example, the ``textile`` filter
  165
+converts text that is marked-up in Textile format to HTML.
155 166
 
156  
-For documentation, read the source code in django/contrib/markup/templatetags/markup.py.
  167
+To activate these filters, add ``'django.contrib.markup'`` to your
  168
+``INSTALLED_APPS`` setting. Once you've done that, use ``{% load markup %}`` in
  169
+a template, and you'll have access to these filters. For more documentation,
  170
+read the source code in django/contrib/markup/templatetags/markup.py.
157 171
 
158 172
 .. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
159 173
 .. _Markdown: http://en.wikipedia.org/wiki/Markdown

0 notes on commit 9a2a9a9

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