python/lib/django_1_4/docs/index.txt

   1
   2 .. _index:
   3
   4 ====================
   5 Django documentation
   6 ====================
   7
   8 .. rubric:: Everything you need to know about Django (and then some).
   9
  10 Getting help
  11 ============
  12
  13 Having trouble? We'd like to help!
  14
  15 * Try the :doc:`FAQ <faq/index>` -- it's got answers to many common questions.
  16
  17 * Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or
  18   the :doc:`detailed table of contents <contents>`.
  19
  20 * Search for information in the `archives of the django-users mailing list`_, or
  21   `post a question`_.
  22
  23 * Ask a question in the `#django IRC channel`_, or search the `IRC logs`_ to see
  24   if it's been asked before.
  25
  26 * Report bugs with Django in our `ticket tracker`_.
  27
  28 .. _archives of the django-users mailing list: http://groups.google.com/group/django-users/
  29 .. _post a question: http://groups.google.com/group/django-users/
  30 .. _#django IRC channel: irc://irc.freenode.net/django
  31 .. _IRC logs: http://django-irc-logs.com/
  32 .. _ticket tracker: https://code.djangoproject.com/
  33
  34 First steps
  35 ===========
  36
  37 * **From scratch:**
  38   :doc:`Overview <intro/overview>` |
  39   :doc:`Installation <intro/install>`
  40
  41 * **Tutorial:**
  42   :doc:`Part 1 <intro/tutorial01>` |
  43   :doc:`Part 2 <intro/tutorial02>` |
  44   :doc:`Part 3 <intro/tutorial03>` |
  45   :doc:`Part 4 <intro/tutorial04>`
  46
  47 The model layer
  48 ===============
  49
  50 * **Models:**
  51   :doc:`Model syntax <topics/db/models>` |
  52   :doc:`Field types <ref/models/fields>` |
  53   :doc:`Meta options <ref/models/options>`
  54
  55 * **QuerySets:**
  56   :doc:`Executing queries <topics/db/queries>` |
  57   :doc:`QuerySet method reference <ref/models/querysets>`
  58
  59 * **Model instances:**
  60   :doc:`Instance methods <ref/models/instances>` |
  61   :doc:`Accessing related objects <ref/models/relations>`
  62
  63 * **Advanced:**
  64   :doc:`Managers <topics/db/managers>` |
  65   :doc:`Raw SQL <topics/db/sql>` |
  66   :doc:`Transactions <topics/db/transactions>` |
  67   :doc:`Aggregation <topics/db/aggregation>` |
  68   :doc:`Custom fields <howto/custom-model-fields>` |
  69   :doc:`Multiple databases <topics/db/multi-db>`
  70
  71 * **Other:**
  72   :doc:`Supported databases <ref/databases>` |
  73   :doc:`Legacy databases <howto/legacy-databases>` |
  74   :doc:`Providing initial data <howto/initial-data>` |
  75   :doc:`Optimize database access <topics/db/optimization>`
  76
  77 The template layer
  78 ==================
  79
  80 * **For designers:**
  81   :doc:`Syntax overview <topics/templates>` |
  82   :doc:`Built-in tags and filters <ref/templates/builtins>`
  83
  84 * **For programmers:**
  85   :doc:`Template API <ref/templates/api>` |
  86   :doc:`Custom tags and filters <howto/custom-template-tags>`
  87
  88 The view layer
  89 ==============
  90
  91 * **The basics:**
  92   :doc:`URLconfs <topics/http/urls>` |
  93   :doc:`View functions <topics/http/views>` |
  94   :doc:`Shortcuts <topics/http/shortcuts>` |
  95   :doc:`Decorators <topics/http/decorators>`
  96
  97 * **Reference:**
  98   :doc:`Request/response objects <ref/request-response>` |
  99   :doc:`TemplateResponse objects <ref/template-response>`
 100
 101 * **File uploads:**
 102   :doc:`Overview <topics/http/file-uploads>` |
 103   :doc:`File objects <ref/files/file>` |
 104   :doc:`Storage API <ref/files/storage>` |
 105   :doc:`Managing files <topics/files>` |
 106   :doc:`Custom storage <howto/custom-file-storage>`
 107
 108 * **Generic views:**
 109   :doc:`Overview<topics/class-based-views>` |
 110   :doc:`Built-in generic views<ref/class-based-views>`
 111
 112 * **Advanced:**
 113   :doc:`Generating CSV <howto/outputting-csv>` |
 114   :doc:`Generating PDF <howto/outputting-pdf>`
 115
 116 * **Middleware:**
 117   :doc:`Overview <topics/http/middleware>` |
 118   :doc:`Built-in middleware classes <ref/middleware>`
 119
 120 Forms
 121 =====
 122
 123 * **The basics:**
 124   :doc:`Overview <topics/forms/index>` |
 125   :doc:`Form API <ref/forms/api>` |
 126   :doc:`Built-in fields <ref/forms/fields>` |
 127   :doc:`Built-in widgets <ref/forms/widgets>`
 128
 129 * **Advanced:**
 130   :doc:`Forms for models <topics/forms/modelforms>` |
 131   :doc:`Integrating media <topics/forms/media>` |
 132   :doc:`Formsets <topics/forms/formsets>` |
 133   :doc:`Customizing validation <ref/forms/validation>`
 134
 135 * **Extras:**
 136   :doc:`Form preview <ref/contrib/formtools/form-preview>` |
 137   :doc:`Form wizard <ref/contrib/formtools/form-wizard>`
 138
 139 The development process
 140 =======================
 141
 142 * **Settings:**
 143   :doc:`Overview <topics/settings>` |
 144   :doc:`Full list of settings <ref/settings>`
 145
 146 * **Exceptions:**
 147   :doc:`Overview <ref/exceptions>`
 148
 149 * **django-admin.py and manage.py:**
 150   :doc:`Overview <ref/django-admin>` |
 151   :doc:`Adding custom commands <howto/custom-management-commands>`
 152
 153 * **Testing:**  :doc:`Overview <topics/testing>`
 154
 155 * **Deployment:**
 156   :doc:`Overview <howto/deployment/index>` |
 157   :doc:`WSGI servers <howto/deployment/wsgi/index>` |
 158   :doc:`FastCGI/SCGI/AJP <howto/deployment/fastcgi>` |
 159   :doc:`Apache/mod_python (deprecated) <howto/deployment/modpython>` |
 160   :doc:`Apache authentication <howto/apache-auth>` |
 161   :doc:`Handling static files <howto/static-files>` |
 162   :doc:`Tracking code errors by email <howto/error-reporting>`
 163
 164 Other batteries included
 165 ========================
 166
 167 * :doc:`Admin site <ref/contrib/admin/index>` | :doc:`Admin actions <ref/contrib/admin/actions>` | :doc:`Admin documentation generator<ref/contrib/admin/admindocs>`
 168 * :doc:`Authentication <topics/auth>`
 169 * :doc:`Cache system <topics/cache>`
 170 * :doc:`Clickjacking protection <ref/clickjacking>`
 171 * :doc:`Comments <ref/contrib/comments/index>` | :doc:`Moderation <ref/contrib/comments/moderation>` | :doc:`Custom comments <ref/contrib/comments/custom>`
 172 * :doc:`Conditional content processing <topics/conditional-view-processing>`
 173 * :doc:`Content types and generic relations <ref/contrib/contenttypes>`
 174 * :doc:`Cross Site Request Forgery protection <ref/contrib/csrf>`
 175 * :doc:`Cryptographic signing <topics/signing>`
 176 * :doc:`Databrowse <ref/contrib/databrowse>`
 177 * :doc:`E-mail (sending) <topics/email>`
 178 * :doc:`Flatpages <ref/contrib/flatpages>`
 179 * :doc:`GeoDjango <ref/contrib/gis/index>`
 180 * :doc:`Humanize <ref/contrib/humanize>`
 181 * :doc:`Internationalization <topics/i18n/index>`
 182 * :doc:`Jython support <howto/jython>`
 183 * :doc:`"Local flavor" <ref/contrib/localflavor>`
 184 * :doc:`Logging <topics/logging>`
 185 * :doc:`Messages <ref/contrib/messages>`
 186 * :doc:`Pagination <topics/pagination>`
 187 * :doc:`Redirects <ref/contrib/redirects>`
 188 * :doc:`Security <topics/security>`
 189 * :doc:`Serialization <topics/serialization>`
 190 * :doc:`Sessions <topics/http/sessions>`
 191 * :doc:`Signals <topics/signals>`
 192 * :doc:`Sitemaps <ref/contrib/sitemaps>`
 193 * :doc:`Sites <ref/contrib/sites>`
 194 * :doc:`Static Files <ref/contrib/staticfiles>`
 195 * :doc:`Syndication feeds (RSS/Atom) <ref/contrib/syndication>`
 196 * :doc:`Unicode in Django <ref/unicode>`
 197 * :doc:`Web design helpers <ref/contrib/webdesign>`
 198 * :doc:`Validators <ref/validators>`
 199 * Function-based generic views (Deprecated) :doc:`Overview<topics/generic-views>` | :doc:`Built-in generic views<ref/generic-views>` | :doc:`Migration guide<topics/generic-views-migration>`
 200
 201 The Django open-source project
 202 ==============================
 203
 204 * **Community:**
 205   :doc:`How to get involved <internals/contributing/index>` |
 206   :doc:`The release process <internals/release-process>` |
 207   :doc:`Team of committers <internals/committers>` |
 208   :doc:`The Django source code repository <internals/svn>`
 209
 210 * **Design philosophies:**
 211   :doc:`Overview <misc/design-philosophies>`
 212
 213 * **Documentation:**
 214   :doc:`About this documentation <internals/contributing/writing-documentation>`
 215
 216 * **Third-party distributions:**
 217   :doc:`Overview <misc/distributions>`
 218
 219 * **Django over time:**
 220   :doc:`API stability <misc/api-stability>` |
 221   :doc:`Release notes and upgrading instructions <releases/index>` |
 222   :doc:`Deprecation Timeline <internals/deprecation>`