PageRenderTime 112ms CodeModel.GetById 95ms app.highlight 1ms RepoModel.GetById 10ms app.codeStats 0ms

/docs/ref/contrib/index.txt

https://code.google.com/p/mango-py/
Plain Text | 204 lines | 133 code | 71 blank | 0 comment | 0 complexity | e07421315a730dad9786f349b26ea601 MD5 | raw file
  1====================
  2``contrib`` packages
  3====================
  4
  5Django aims to follow Python's `"batteries included" philosophy`_. It ships
  6with a variety of extra, optional tools that solve common Web-development
  7problems.
  8
  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 :setting:`INSTALLED_APPS` setting and
 18    re-run ``manage.py syncdb``.
 19
 20.. _"batteries included" philosophy: http://docs.python.org/tutorial/stdlib.html#batteries-included
 21
 22.. toctree::
 23   :maxdepth: 1
 24
 25   admin/index
 26   auth
 27   comments/index
 28   contenttypes
 29   csrf
 30   databrowse
 31   flatpages
 32   formtools/index
 33   gis/index
 34   humanize
 35   localflavor
 36   markup
 37   messages
 38   redirects
 39   sitemaps
 40   sites
 41   staticfiles
 42   syndication
 43   webdesign
 44
 45admin
 46=====
 47
 48The automatic Django administrative interface. For more information, see
 49:doc:`Tutorial 2 </intro/tutorial02>` and the
 50:doc:`admin documentation </ref/contrib/admin/index>`.
 51
 52Requires the auth_ and contenttypes_ contrib packages to be installed.
 53
 54auth
 55====
 56
 57Django's authentication framework.
 58
 59See :doc:`/topics/auth`.
 60
 61comments
 62========
 63
 64A simple yet flexible comments system. See :doc:`/ref/contrib/comments/index`.
 65
 66contenttypes
 67============
 68
 69A light framework for hooking into "types" of content, where each installed
 70Django model is a separate content type.
 71
 72See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`.
 73
 74csrf
 75====
 76
 77A middleware for preventing Cross Site Request Forgeries
 78
 79See the :doc:`csrf documentation </ref/contrib/csrf>`.
 80
 81flatpages
 82=========
 83
 84A framework for managing simple "flat" HTML content in a database.
 85
 86See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
 87
 88Requires the sites_ contrib package to be installed as well.
 89
 90formtools
 91=========
 92
 93A set of high-level abstractions for Django forms (django.forms).
 94
 95django.contrib.formtools.preview
 96--------------------------------
 97
 98An abstraction of the following workflow:
 99
100"Display an HTML form, force a preview, then do something with the submission."
101
102See the :doc:`form preview documentation </ref/contrib/formtools/form-preview>`.
103
104django.contrib.formtools.wizard
105--------------------------------
106
107Splits forms across multiple Web pages.
108
109See the :doc:`form wizard documentation </ref/contrib/formtools/form-wizard>`.
110
111gis
112====
113
114A world-class geospatial framework built on top of Django, that enables
115storage, manipulation and display of spatial data.
116
117See the :doc:`/ref/contrib/gis/index` documentation for more.
118
119humanize
120========
121
122A set of Django template filters useful for adding a "human touch" to data.
123
124See the :doc:`humanize documentation </ref/contrib/humanize>`.
125
126localflavor
127===========
128
129A collection of various Django snippets that are useful only for a particular
130country or culture. For example, ``django.contrib.localflavor.us.forms``
131contains a ``USZipCodeField`` that you can use to validate U.S. zip codes.
132
133See the :doc:`localflavor documentation </ref/contrib/localflavor>`.
134
135markup
136======
137
138A collection of template filters that implement common markup languages
139
140See the :doc:`markup documentation </ref/contrib/markup>`.
141
142messages
143========
144
145.. versionchanged:: 1.2
146    The messages framework was added.
147
148A framework for storing and retrieving temporary cookie- or session-based
149messages
150
151See the :doc:`messages documentation </ref/contrib/messages>`.
152
153redirects
154=========
155
156A framework for managing redirects.
157
158See the :doc:`redirects documentation </ref/contrib/redirects>`.
159
160sessions
161========
162
163A framework for storing data in anonymous sessions.
164
165See the :doc:`sessions documentation </topics/http/sessions>`.
166
167sites
168=====
169
170A light framework that lets you operate multiple Web sites off of the same
171database and Django installation. It gives you hooks for associating objects to
172one or more sites.
173
174See the :doc:`sites documentation </ref/contrib/sites>`.
175
176sitemaps
177========
178
179A framework for generating Google sitemap XML files.
180
181See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`.
182
183syndication
184===========
185
186A framework for generating syndication feeds, in RSS and Atom, quite easily.
187
188See the :doc:`syndication documentation </ref/contrib/syndication>`.
189
190webdesign
191=========
192
193Helpers and utilities targeted primarily at Web *designers* rather than
194Web *developers*.
195
196See the :doc:`Web design helpers documentation </ref/contrib/webdesign>`.
197
198Other add-ons
199=============
200
201If you have an idea for functionality to include in ``contrib``, let us know!
202Code it up, and post it to the `django-users mailing list`_.
203
204.. _django-users mailing list: http://groups.google.com/group/django-users