Django

Code

Show
Ignore:
Timestamp:
06/17/07 17:18:54 (2 years ago)
Author:
clong
Message:

per-object-permissions: Merged to trunk [5486] NOTE: Not fully tested, will be working on this over the next few weeks.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/branches/per-object-permissions/docs/add_ons.txt

    r4242 r5488  
    1 ===================== 
    2 The "contrib" add-ons 
    3 ===================== 
     1============================ 
     2The "django.contrib" add-ons 
     3============================ 
    44 
    55Django aims to follow Python's `"batteries included" philosophy`_. It ships 
     
    77problems. 
    88 
    9 This code lives in ``django/contrib`` in the Django distribution. Here's a 
    10 rundown of the packages in ``contrib``: 
     9This code lives in ``django/contrib`` in the Django distribution. This document 
     10gives a rundown of the packages in ``contrib``, along with any dependencies 
     11those packages have. 
     12 
     13.. admonition:: Note 
     14 
     15    For most of these add-ons -- specifically, the add-ons that include either 
     16    models or template tags -- you'll need to add the package name (e.g., 
     17    ``'django.contrib.admin'``) to your ``INSTALLED_APPS`` setting and re-run 
     18    ``manage.py syncdb``. 
    1119 
    1220.. _"batteries included" philosophy: http://docs.python.org/tut/node12.html#batteries-included 
     
    1826`Tutorial 2`_. 
    1927 
    20 .. _Tutorial 2: http://www.djangoproject.com/documentation/tutorial2/ 
     28.. _Tutorial 2: ../tutorial02/ 
     29 
     30Requires the auth_ and contenttypes_ contrib packages to be installed. 
    2131 
    2232auth 
     
    2737See the `authentication documentation`_. 
    2838 
    29 .. _authentication documentation: http://www.djangoproject.com/documentation/authentication/ 
     39.. _authentication documentation: ../authentication/ 
    3040 
    3141comments 
     
    4757See the `csrf documentation`_. 
    4858 
    49 .. _csrf documentation: http://www.djangoproject.com/documentation/csrf/ 
     59.. _csrf documentation: ../csrf/ 
    5060 
    5161formtools 
    5262========= 
    53  
    54 **New in Django development version** 
    5563 
    5664A set of high-level abstractions for Django forms (django.newforms). 
     
    138146See the `flatpages documentation`_. 
    139147 
    140 .. _flatpages documentation: http://www.djangoproject.com/documentation/flatpages/ 
     148.. _flatpages documentation: ../flatpages/ 
     149 
     150Requires the sites_ contrib package to be installed as well. 
     151 
     152localflavor 
     153=========== 
     154 
     155A collection of various Django snippets that are useful only for a particular 
     156country or culture. For example, ``django.contrib.localflavor.usa.forms`` 
     157contains a ``USZipCodeField`` that you can use to validate U.S. zip codes. 
    141158 
    142159markup 
    143160====== 
    144161 
    145 A collection of template filters that implement these common markup languages: 
    146  
    147     * Textile 
    148     * Markdown 
    149     * ReST (ReStructured Text) 
    150  
    151 For documentation, read the source code in django/contrib/markup/templatetags/markup.py. 
     162A collection of template filters that implement common markup languages: 
     163 
     164    * ``textile`` -- implements `Textile`_ 
     165    * ``markdown`` -- implements `Markdown`_ 
     166    * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_ 
     167 
     168In each case, the filter expects formatted markup as a string and returns a 
     169string representing the marked-up text. For example, the ``textile`` filter 
     170converts text that is marked-up in Textile format to HTML. 
     171 
     172To activate these filters, add ``'django.contrib.markup'`` to your 
     173``INSTALLED_APPS`` setting. Once you've done that, use ``{% load markup %}`` in 
     174a template, and you'll have access to these filters. For more documentation, 
     175read the source code in django/contrib/markup/templatetags/markup.py. 
     176 
     177.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29 
     178.. _Markdown: http://en.wikipedia.org/wiki/Markdown 
     179.. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText 
    152180 
    153181redirects 
     
    158186See the `redirects documentation`_. 
    159187 
    160 .. _redirects documentation: http://www.djangoproject.com/documentation/redirects/ 
     188.. _redirects documentation: ../redirects/ 
    161189 
    162190sites 
     
    169197See the `sites documentation`_. 
    170198 
    171 .. _sites documentation: http://www.djangoproject.com/documentation/sites/ 
     199.. _sites documentation: ../sites/ 
    172200 
    173201sitemaps 
     
    178206See the `sitemaps documentation`_. 
    179207 
    180 .. _sitemaps documentation: http://www.djangoproject.com/documentation/sitemaps/ 
     208.. _sitemaps documentation: ../sitemaps/ 
    181209 
    182210syndication 
     
    187215See the `syndication documentation`_. 
    188216 
    189 .. _syndication documentation: http://www.djangoproject.com/documentation/syndication/ 
     217.. _syndication documentation: ../syndication/ 
    190218 
    191219Other add-ons