innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity
django1/docs/ref/contrib/index.txt

144 lines
3.3 KiB
Plaintext
Raw Normal View History

Fixed #9465 -- Simplified API Reference documentation titles for easier lookup and made first-level heading styles consistent. Thanks, adamnelson. git-svn-id: http://code.djangoproject.com/svn/django/trunk@11990 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-12-26 11:44:21 +08:00
====================
``contrib`` packages
====================
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
Added link to 'batteries included' explanation in docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@3509 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-08-02 04:48:26 +08:00
Django aims to follow Python's `"batteries included" philosophy`_. It ships
with a variety of extra, optional tools that solve common Web-development
problems.
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
Fixed #1791 - documented dependancies of contrib packages. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5432 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-06-08 01:50:53 +08:00
This code lives in ``django/contrib`` in the Django distribution. This document
Fixed misspelling in docs/add_ons.txt from [5432] git-svn-id: http://code.djangoproject.com/svn/django/trunk@5439 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-06-08 05:41:41 +08:00
gives a rundown of the packages in ``contrib``, along with any dependencies
Fixed #1791 - documented dependancies of contrib packages. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5432 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-06-08 01:50:53 +08:00
those packages have.
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
Fixed #3781 -- Improved docs/add_ons.txt to clarify use of contrib apps. Thanks, Simon G. git-svn-id: http://code.djangoproject.com/svn/django/trunk@4833 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-03-28 06:18:52 +08:00
.. 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.,
Fixed #21712 -- Moved autodiscover() to AdminConfig.ready(). Thanks Marc Tamlyn for the initial version of the patch.
2014-01-19 02:34:54 +08:00
``'django.contrib.redirects'``) to your :setting:`INSTALLED_APPS` setting
and re-run ``manage.py migrate``.
Fixed #3781 -- Improved docs/add_ons.txt to clarify use of contrib apps. Thanks, Simon G. git-svn-id: http://code.djangoproject.com/svn/django/trunk@4833 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-03-28 06:18:52 +08:00
Used https for most *.python.org links
2014-12-19 23:25:57 +08:00
.. _"batteries included" philosophy: https://docs.python.org/tutorial/stdlib.html#batteries-included
Added link to 'batteries included' explanation in docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@3509 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-08-02 04:48:26 +08:00
Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/. git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-24 06:25:40 +08:00
.. toctree::
:maxdepth: 1
Fixed #10505: added support for bulk admin actions, including a globally-available "delete selected" action. See the documentation for details. This work started life as Brian Beck's "django-batchadmin." It was rewritten for inclusion in Django by Alex Gaynor, Jannis Leidel (jezdez), and Martin Mahner (bartTC). Thanks, guys! git-svn-id: http://code.djangoproject.com/svn/django/trunk@10121 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-24 04:22:56 +08:00
admin/index
Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/. git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-24 06:25:40 +08:00
auth
contenttypes
flatpages
Fixed #12930, #12832, #11538 -- Refactored and merged the GeoDjango documentation into the rest of the Django docs. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12856 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-03-27 04:14:53 +08:00
gis/index
Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/. git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-24 06:25:40 +08:00
humanize
Fixed #4604 - Configurable message passing system, supporting anonymous users This deprecates User.message_set in favour of a configurable messaging system, with backends provided for cookie storage, session storage and backward compatibility. Many thanks to Tobias McNulty for the bulk of the work here, with contributions from Chris Beaven (SmileyChris) and lots of code review from Russell Keith-Magee, and input from many others. Also credit to the authors of various messaging systems for Django whose ideas may have been pinched :-) git-svn-id: http://code.djangoproject.com/svn/django/trunk@11804 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-12-10 00:57:23 +08:00
messages
Added array field support for PostgreSQL. The first part of django.contrib.postgres, including model and two form fields for arrays of other data types. This commit is formed of the following work: Add shell of postgres app and test handling. First draft of array fields. Use recursive deconstruction. Stop creating classes at lookup time. Add validation and size parameter. Add contained_by lookup. Add SimpleArrayField for forms. Add SplitArrayField (mainly for admin). Fix prepare_value for SimpleArrayField. Stop using MultiValueField and MultiWidget. They don't play nice with flexible sizes. Add basics of admin integration. Missing: - Tests - Fully working js Add reference document for django.contrib.postgres.fields.ArrayField. Various performance and style tweaks. Fix internal docs link, formalise code snippets. Remove the admin code for now. It needs a better way of handing JS widgets in the admin as a whole before it is easy to write. In particular there are serious issues involving DateTimePicker when used in an array. Add a test for nested array fields with different delimiters. This will be a documented pattern so having a test for it is useful. Add docs for SimpleArrayField. Add docs for SplitArrayField. Remove admin related code for now. definition -> description Fix typo. Py3 errors. Avoid using regexes where they're not needed. Allow passing tuples by the programmer. Add some more tests for multidimensional arrays. Also fix slicing as much as it can be fixed. Simplify SplitArrayWidget's data loading. If we aren't including the variable size one, we don't need to search like this.
2014-03-27 00:44:21 +08:00
postgres/index
Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/. git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-24 06:25:40 +08:00
redirects
sitemaps
sites
Fixed #12323 and #11582 -- Extended the ability to handle static files. Thanks to all for helping with the original app, the patch, documentation and general support. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14293 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-10-20 09:33:24 +08:00
staticfiles
Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/. git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-24 06:25:40 +08:00
syndication
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
admin
=====
The automatic Django administrative interface. For more information, see
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
:doc:`Tutorial 2 </intro/tutorial02>` and the
:doc:`admin documentation </ref/contrib/admin/index>`.
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
Fixed #1791 - documented dependancies of contrib packages. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5432 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-06-08 01:50:53 +08:00
Requires the auth_ and contenttypes_ contrib packages to be installed.
Added the missing django.contrib applications to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@2956 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-05-22 11:14:33 +08:00
auth
====
Django's authentication framework.
Fixed #19498 -- refactored auth documentation The auth doc was a single page which had grown unwieldy. This refactor split and grouped the content into sub-topics. Additional corrections and cleanups were made along the way.
2012-12-29 03:00:11 +08:00
See :doc:`/topics/auth/index`.
Added the missing django.contrib applications to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@2956 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-05-22 11:14:33 +08:00
contenttypes
============
A light framework for hooking into "types" of content, where each installed
Fixed #5561 -- Added link to the contenttypes documentation into the add_ons document. Pointed out by Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@6925 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-12-17 15:39:24 +08:00
Django model is a separate content type.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`.
Added the missing django.contrib applications to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@2956 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-05-22 11:14:33 +08:00
Fixed #5940: added sessions and webdesign cross-references to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@6788 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-12-02 01:07:32 +08:00
flatpages
=========
A framework for managing simple "flat" HTML content in a database.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
Fixed #5940: added sessions and webdesign cross-references to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@6788 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-12-02 01:07:32 +08:00
Requires the sites_ contrib package to be installed as well.
Fixed #12930, #12832, #11538 -- Refactored and merged the GeoDjango documentation into the rest of the Django docs. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12856 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-03-27 04:14:53 +08:00
gis
====
A world-class geospatial framework built on top of Django, that enables
storage, manipulation and display of spatial data.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`/ref/contrib/gis/index` documentation for more.
Fixed #12930, #12832, #11538 -- Refactored and merged the GeoDjango documentation into the rest of the Django docs. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12856 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-03-27 04:14:53 +08:00
Added django.contrib.humanize, a set of template tags for adding a 'human touch' to data. They're documented in add_ons.txt. git-svn-id: http://code.djangoproject.com/svn/django/trunk@3076 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-06-04 08:58:39 +08:00
humanize
========
A set of Django template filters useful for adding a "human touch" to data.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`humanize documentation </ref/contrib/humanize>`.
Fixed #3311 -- Added naturalday filter to contrib.humanize. Thanks, Jyrki Pulliainen. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5985 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-08-20 16:50:08 +08:00
Fixed #4604 - Configurable message passing system, supporting anonymous users This deprecates User.message_set in favour of a configurable messaging system, with backends provided for cookie storage, session storage and backward compatibility. Many thanks to Tobias McNulty for the bulk of the work here, with contributions from Chris Beaven (SmileyChris) and lots of code review from Russell Keith-Magee, and input from many others. Also credit to the authors of various messaging systems for Django whose ideas may have been pinched :-) git-svn-id: http://code.djangoproject.com/svn/django/trunk@11804 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-12-10 00:57:23 +08:00
messages
========
A framework for storing and retrieving temporary cookie- or session-based
messages
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`messages documentation </ref/contrib/messages>`.
Fixed #4604 - Configurable message passing system, supporting anonymous users This deprecates User.message_set in favour of a configurable messaging system, with backends provided for cookie storage, session storage and backward compatibility. Many thanks to Tobias McNulty for the bulk of the work here, with contributions from Chris Beaven (SmileyChris) and lots of code review from Russell Keith-Magee, and input from many others. Also credit to the authors of various messaging systems for Django whose ideas may have been pinched :-) git-svn-id: http://code.djangoproject.com/svn/django/trunk@11804 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-12-10 00:57:23 +08:00
Added array field support for PostgreSQL. The first part of django.contrib.postgres, including model and two form fields for arrays of other data types. This commit is formed of the following work: Add shell of postgres app and test handling. First draft of array fields. Use recursive deconstruction. Stop creating classes at lookup time. Add validation and size parameter. Add contained_by lookup. Add SimpleArrayField for forms. Add SplitArrayField (mainly for admin). Fix prepare_value for SimpleArrayField. Stop using MultiValueField and MultiWidget. They don't play nice with flexible sizes. Add basics of admin integration. Missing: - Tests - Fully working js Add reference document for django.contrib.postgres.fields.ArrayField. Various performance and style tweaks. Fix internal docs link, formalise code snippets. Remove the admin code for now. It needs a better way of handing JS widgets in the admin as a whole before it is easy to write. In particular there are serious issues involving DateTimePicker when used in an array. Add a test for nested array fields with different delimiters. This will be a documented pattern so having a test for it is useful. Add docs for SimpleArrayField. Add docs for SplitArrayField. Remove admin related code for now. definition -> description Fix typo. Py3 errors. Avoid using regexes where they're not needed. Allow passing tuples by the programmer. Add some more tests for multidimensional arrays. Also fix slicing as much as it can be fixed. Simplify SplitArrayWidget's data loading. If we aren't including the variable size one, we don't need to search like this.
2014-03-27 00:44:21 +08:00
postgres
========
A collection of PostgreSQL specific features.
See the :doc:`contrib.postgres documentation </ref/contrib/postgres/index>`.
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
redirects
=========
A framework for managing redirects.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`redirects documentation </ref/contrib/redirects>`.
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
Fixed #5940: added sessions and webdesign cross-references to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@6788 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-12-02 01:07:32 +08:00
sessions
========
A framework for storing data in anonymous sessions.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`sessions documentation </topics/http/sessions>`.
Fixed #5940: added sessions and webdesign cross-references to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@6788 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-12-02 01:07:32 +08:00
Added the missing django.contrib applications to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@2956 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-05-22 11:14:33 +08:00
sites
=====
A light framework that lets you operate multiple Web sites off of the same
database and Django installation. It gives you hooks for associating objects to
Added docs/sites.txt -- documentation on the sites framework git-svn-id: http://code.djangoproject.com/svn/django/trunk@2958 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-05-22 12:48:44 +08:00
one or more sites.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`sites documentation </ref/contrib/sites>`.
Added the missing django.contrib applications to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@2956 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-05-22 11:14:33 +08:00
Added 'sitemaps' to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@3697 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-09-01 07:19:53 +08:00
sitemaps
========
A framework for generating Google sitemap XML files.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`.
Added 'sitemaps' to docs/add_ons.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@3697 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2006-09-01 07:19:53 +08:00
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
syndication
===========
A framework for generating syndication feeds, in RSS and Atom, quite easily.
Fixed #14141: docs now use the :doc: construct for links between documents. Thanks, Ramiro Morales. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-20 03:27:44 +08:00
See the :doc:`syndication documentation </ref/contrib/syndication>`.
Added docs/add_ons.txt -- small documentation of contrib git-svn-id: http://code.djangoproject.com/svn/django/trunk@1354 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2005-11-23 03:21:51 +08:00
Other add-ons
=============
If you have an idea for functionality to include in ``contrib``, let us know!
Fixed #21213 -- Added docs for Django's mailing lists. Added docs/internals/mailing-lists.txt documenting the use of django's mailing lists. All references across docs changed to point to this page. The referencing makes use of substitution because there's no way to make a :ref: link in a non-inline fashion in Sphinx. It also makes use of rst_epilog Sphinx conf for making this substitutions across all the docs.
2013-10-04 06:51:22 +08:00
Code it up, and post it to the |django-users| mailing list.