1
0
mirror of https://github.com/django/django.git synced 2024-12-30 21:16:26 +00:00
django/docs/ref/contrib/index.txt
Tobias Kunze 4a954cfd11 Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:

- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous

Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00

142 lines
3.4 KiB
Plaintext

====================
``contrib`` packages
====================
Django aims to follow Python's :ref:`"batteries included" philosophy
<tut-batteries-included>`. It ships with a variety of extra, optional tools
that solve common Web-development problems.
This code lives in ``django/contrib`` in the Django distribution. This document
gives a rundown of the packages in ``contrib``, along with any dependencies
those packages have.
.. 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.redirects'``) to your :setting:`INSTALLED_APPS` setting
and re-run ``manage.py migrate``.
.. toctree::
:maxdepth: 1
admin/index
auth
contenttypes
flatpages
gis/index
humanize
messages
postgres/index
redirects
sitemaps
sites
staticfiles
syndication
``admin``
=========
The automatic Django administrative interface. For more information, see
:doc:`Tutorial 2 </intro/tutorial02>` and the
:doc:`admin documentation </ref/contrib/admin/index>`.
Requires the auth_ and contenttypes_ contrib packages to be installed.
``auth``
========
Django's authentication framework.
See :doc:`/topics/auth/index`.
``contenttypes``
================
A light framework for hooking into "types" of content, where each installed
Django model is a separate content type.
See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`.
``flatpages``
=============
A framework for managing "flat" HTML content in a database.
See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
Requires the sites_ contrib package to be installed as well.
``gis``
=======
A world-class geospatial framework built on top of Django, that enables
storage, manipulation and display of spatial data.
See the :doc:`/ref/contrib/gis/index` documentation for more.
``humanize``
============
A set of Django template filters useful for adding a "human touch" to data.
See the :doc:`humanize documentation </ref/contrib/humanize>`.
``messages``
============
A framework for storing and retrieving temporary cookie- or session-based
messages
See the :doc:`messages documentation </ref/contrib/messages>`.
``postgres``
============
A collection of PostgreSQL specific features.
See the :doc:`contrib.postgres documentation </ref/contrib/postgres/index>`.
``redirects``
=============
A framework for managing redirects.
See the :doc:`redirects documentation </ref/contrib/redirects>`.
``sessions``
============
A framework for storing data in anonymous sessions.
See the :doc:`sessions documentation </topics/http/sessions>`.
``sites``
=========
A light framework that lets you operate multiple websites off of the same
database and Django installation. It gives you hooks for associating objects to
one or more sites.
See the :doc:`sites documentation </ref/contrib/sites>`.
``sitemaps``
============
A framework for generating Google sitemap XML files.
See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`.
``syndication``
===============
A framework for generating syndication feeds, in RSS and Atom, quite easily.
See the :doc:`syndication documentation </ref/contrib/syndication>`.
Other add-ons
=============
If you have an idea for functionality to include in ``contrib``, let us know!
Code it up, and post it to the |django-users| mailing list.