2
0

index.txt 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. ====================
  2. ``contrib`` packages
  3. ====================
  4. Django aims to follow Python's :ref:`"batteries included" philosophy
  5. <tut-batteries-included>`. It ships with a variety of extra, optional tools
  6. that solve common web development problems.
  7. This code lives in :source:`django/contrib` in the Django distribution. This document
  8. gives a rundown of the packages in ``contrib``, along with any dependencies
  9. those packages have.
  10. .. admonition:: Including ``contrib`` packages in ``INSTALLED_APPS``
  11. For most of these add-ons -- specifically, the add-ons that include either
  12. models or template tags -- you'll need to add the package name (e.g.,
  13. ``'django.contrib.redirects'``) to your :setting:`INSTALLED_APPS` setting
  14. and rerun ``manage.py migrate``.
  15. .. toctree::
  16. :maxdepth: 1
  17. admin/index
  18. auth
  19. contenttypes
  20. flatpages
  21. gis/index
  22. humanize
  23. messages
  24. postgres/index
  25. redirects
  26. sitemaps
  27. sites
  28. staticfiles
  29. syndication
  30. ``admin``
  31. =========
  32. The automatic Django administrative interface. For more information, see
  33. :doc:`Tutorial 2 </intro/tutorial02>` and the
  34. :doc:`admin documentation </ref/contrib/admin/index>`.
  35. Requires the auth_ and contenttypes_ contrib packages to be installed.
  36. ``auth``
  37. ========
  38. Django's authentication framework.
  39. See :doc:`/topics/auth/index`.
  40. ``contenttypes``
  41. ================
  42. A light framework for hooking into "types" of content, where each installed
  43. Django model is a separate content type.
  44. See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`.
  45. ``flatpages``
  46. =============
  47. A framework for managing "flat" HTML content in a database.
  48. See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
  49. Requires the sites_ contrib package to be installed as well.
  50. ``gis``
  51. =======
  52. A world-class geospatial framework built on top of Django, that enables
  53. storage, manipulation and display of spatial data.
  54. See the :doc:`/ref/contrib/gis/index` documentation for more.
  55. ``humanize``
  56. ============
  57. A set of Django template filters useful for adding a "human touch" to data.
  58. See the :doc:`humanize documentation </ref/contrib/humanize>`.
  59. ``messages``
  60. ============
  61. A framework for storing and retrieving temporary cookie- or session-based
  62. messages
  63. See the :doc:`messages documentation </ref/contrib/messages>`.
  64. ``postgres``
  65. ============
  66. A collection of PostgreSQL specific features.
  67. See the :doc:`contrib.postgres documentation </ref/contrib/postgres/index>`.
  68. ``redirects``
  69. =============
  70. A framework for managing redirects.
  71. See the :doc:`redirects documentation </ref/contrib/redirects>`.
  72. ``sessions``
  73. ============
  74. A framework for storing data in anonymous sessions.
  75. See the :doc:`sessions documentation </topics/http/sessions>`.
  76. ``sites``
  77. =========
  78. A light framework that lets you operate multiple websites off of the same
  79. database and Django installation. It gives you hooks for associating objects to
  80. one or more sites.
  81. See the :doc:`sites documentation </ref/contrib/sites>`.
  82. ``sitemaps``
  83. ============
  84. A framework for generating Google sitemap XML files.
  85. See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`.
  86. ``syndication``
  87. ===============
  88. A framework for generating syndication feeds, in RSS and Atom, quite easily.
  89. See the :doc:`syndication documentation </ref/contrib/syndication>`.
  90. Other add-ons
  91. =============
  92. If you have an idea for functionality to include in ``contrib``, let us know!
  93. Code it up, and post it to the |django-users| mailing list.