Django

Code

Changeset 4833

Show
Ignore:
Timestamp:
03/27/07 17:18:52 (2 years ago)
Author:
adrian
Message:

Fixed #3781 -- Improved docs/add_ons.txt to clarify use of contrib apps. Thanks, Simon G.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • django/trunk/docs/add_ons.txt

    r4804 r4833  
    99This code lives in ``django/contrib`` in the Django distribution. Here's a 
    1010rundown of the packages in ``contrib``: 
     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``. 
    1118 
    1219.. _"batteries included" philosophy: http://docs.python.org/tut/node12.html#batteries-included 
    …… 
    148155====== 
    149156 
    150 A collection of template filters that implement these common markup languages: 
    151  
    152     * `Textile`_ 
    153     * `Markdown`_ 
    154     * `ReST (ReStructured Text)`_ 
    155  
    156 For documentation, read the source code in django/contrib/markup/templatetags/markup.py. 
     157A collection of template filters that implement common markup languages: 
     158 
     159    * ``textile`` -- implements `Textile`_ 
     160    * ``markdown`` -- implements `Markdown`_ 
     161    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_ 
     162 
     163In each case, the filter expects formatted markup as a string and returns a 
     164string representing the marked-up text. For example, the ``textile`` filter 
     165converts text that is marked-up in Textile format to HTML. 
     166 
     167To activate these filters, add ``'django.contrib.markup'`` to your 
     168``INSTALLED_APPS`` setting. Once you've done that, use ``{% load markup %}`` in 
     169a template, and you'll have access to these filters. For more documentation, 
     170read the source code in django/contrib/markup/templatetags/markup.py. 
    157171 
    158172.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29