Django-1.2.1/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 :ref:`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 :ref:`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 its 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://botland.oebfare.com/logger/django/
  32 .. _ticket tracker: http://code.djangoproject.com/
  33
  34 First steps
  35 ===========
  36
  37     * **From scratch:**
  38       :ref:`Overview <intro-overview>` |
  39       :ref:`Installation <intro-install>`
  40
  41     * **Tutorial:**
  42       :ref:`Part 1 <intro-tutorial01>` |
  43       :ref:`Part 2 <intro-tutorial02>` |
  44       :ref:`Part 3 <intro-tutorial03>` |
  45       :ref:`Part 4 <intro-tutorial04>`
  46
  47 The model layer
  48 ===============
  49
  50     * **Models:**
  51       :ref:`Model syntax <topics-db-models>` |
  52       :ref:`Field types <ref-models-fields>` |
  53       :ref:`Meta options <ref-models-options>`
  54
  55     * **QuerySets:**
  56       :ref:`Executing queries <topics-db-queries>` |
  57       :ref:`QuerySet method reference <ref-models-querysets>`
  58
  59     * **Model instances:**
  60       :ref:`Instance methods <ref-models-instances>` |
  61       :ref:`Accessing related objects <ref-models-relations>`
  62
  63     * **Advanced:**
  64       :ref:`Managers <topics-db-managers>` |
  65       :ref:`Raw SQL <topics-db-sql>` |
  66       :ref:`Transactions <topics-db-transactions>` |
  67       :ref:`Aggregation <topics-db-aggregation>` |
  68       :ref:`Custom fields <howto-custom-model-fields>` |
  69       :ref:`Multiple databases <topics-db-multi-db>`
  70
  71     * **Other:**
  72       :ref:`Supported databases <ref-databases>` |
  73       :ref:`Legacy databases <howto-legacy-databases>` |
  74       :ref:`Providing initial data <howto-initial-data>` |
  75       :ref:`Optimize database access <topics-db-optimization>`
  76
  77 The template layer
  78 ==================
  79
  80     * **For designers:**
  81       :ref:`Syntax overview <topics-templates>` |
  82       :ref:`Built-in tags and filters <ref-templates-builtins>`
  83
  84     * **For programmers:**
  85       :ref:`Template API <ref-templates-api>` |
  86       :ref:`Custom tags and filters <howto-custom-template-tags>`
  87
  88 The view layer
  89 ==============
  90
  91     * **The basics:**
  92       :ref:`URLconfs <topics-http-urls>` |
  93       :ref:`View functions <topics-http-views>` |
  94       :ref:`Shortcuts <topics-http-shortcuts>`
  95
  96     * **Reference:**  :ref:`Request/response objects <ref-request-response>`
  97
  98     * **File uploads:**
  99       :ref:`Overview <topics-http-file-uploads>` |
 100       :ref:`File objects <ref-files-file>` |
 101       :ref:`Storage API <ref-files-storage>` |
 102       :ref:`Managing files <topics-files>` |
 103       :ref:`Custom storage <howto-custom-file-storage>`
 104
 105     * **Generic views:**
 106       :ref:`Overview<topics-generic-views>` |
 107       :ref:`Built-in generic views<ref-generic-views>`
 108
 109     * **Advanced:**
 110       :ref:`Generating CSV <howto-outputting-csv>` |
 111       :ref:`Generating PDF <howto-outputting-pdf>`
 112
 113     * **Middleware:**
 114       :ref:`Overview <topics-http-middleware>` |
 115       :ref:`Built-in middleware classes <ref-middleware>`
 116
 117 Forms
 118 =====
 119
 120     * **The basics:**
 121       :ref:`Overview <topics-forms-index>` |
 122       :ref:`Form API <ref-forms-api>` |
 123       :ref:`Built-in fields <ref-forms-fields>` |
 124       :ref:`Built-in widgets <ref-forms-widgets>`
 125
 126     * **Advanced:**
 127       :ref:`Forms for models <topics-forms-modelforms>` |
 128       :ref:`Integrating media <topics-forms-media>` |
 129       :ref:`Formsets <topics-forms-formsets>` |
 130       :ref:`Customizing validation <ref-forms-validation>`
 131
 132     * **Extras:**
 133       :ref:`Form preview <ref-contrib-formtools-form-preview>` |
 134       :ref:`Form wizard <ref-contrib-formtools-form-wizard>`
 135
 136 The development process
 137 =======================
 138
 139     * **Settings:**
 140       :ref:`Overview <topics-settings>` |
 141       :ref:`Full list of settings <ref-settings>`
 142
 143     * **Exceptions:**
 144       :ref:`Overview <ref-exceptions>`
 145
 146     * **django-admin.py and manage.py:**
 147       :ref:`Overview <ref-django-admin>` |
 148       :ref:`Adding custom commands <howto-custom-management-commands>`
 149
 150     * **Testing:**  :ref:`Overview <topics-testing>`
 151
 152     * **Deployment:**
 153       :ref:`Overview <howto-deployment-index>` |
 154       :ref:`Apache/mod_wsgi <howto-deployment-modwsgi>` |
 155       :ref:`Apache/mod_python <howto-deployment-modpython>` |
 156       :ref:`FastCGI/SCGI/AJP <howto-deployment-fastcgi>` |
 157       :ref:`Apache authentication <howto-apache-auth>` |
 158       :ref:`Serving static files <howto-static-files>` |
 159       :ref:`Tracking code errors by e-mail <howto-error-reporting>`
 160
 161 Other batteries included
 162 ========================
 163
 164     * :ref:`Admin site <ref-contrib-admin>` | :ref:`Admin actions <ref-contrib-admin-actions>`
 165     * :ref:`Authentication <topics-auth>`
 166     * :ref:`Cache system <topics-cache>`
 167     * :ref:`Conditional content processing <topics-conditional-processing>`
 168     * :ref:`Comments <ref-contrib-comments-index>` | :ref:`Moderation <ref-contrib-comments-moderation>` | :ref:`Custom comments <ref-contrib-comments-custom>`
 169     * :ref:`Content types <ref-contrib-contenttypes>`
 170     * :ref:`Cross Site Request Forgery protection <ref-contrib-csrf>`
 171     * :ref:`Databrowse <ref-contrib-databrowse>`
 172     * :ref:`E-mail (sending) <topics-email>`
 173     * :ref:`Flatpages <ref-contrib-flatpages>`
 174     * :ref:`GeoDjango <ref-contrib-gis>`
 175     * :ref:`Humanize <ref-contrib-humanize>`
 176     * :ref:`Internationalization <topics-i18n>`
 177     * :ref:`Jython support <howto-jython>`
 178     * :ref:`"Local flavor" <ref-contrib-localflavor>`
 179     * :ref:`Messages <ref-contrib-messages>`
 180     * :ref:`Pagination <topics-pagination>`
 181     * :ref:`Redirects <ref-contrib-redirects>`
 182     * :ref:`Serialization <topics-serialization>`
 183     * :ref:`Sessions <topics-http-sessions>`
 184     * :ref:`Signals <topics-signals>`
 185     * :ref:`Sitemaps <ref-contrib-sitemaps>`
 186     * :ref:`Sites <ref-contrib-sites>`
 187     * :ref:`Syndication feeds (RSS/Atom) <ref-contrib-syndication>`
 188     * :ref:`Unicode in Django <ref-unicode>`
 189     * :ref:`Web design helpers <ref-contrib-webdesign>`
 190     * :ref:`Validators <ref-validators>`
 191
 192 The Django open-source project
 193 ==============================
 194
 195     * **Community:**
 196       :ref:`How to get involved <internals-contributing>` |
 197       :ref:`The release process <internals-release-process>` |
 198       :ref:`Team of committers <internals-committers>` |
 199       :ref:`The Django source code repository <internals-svn>`
 200
 201     * **Design philosophies:**
 202       :ref:`Overview <misc-design-philosophies>`
 203
 204     * **Documentation:**
 205       :ref:`About this documentation <internals-documentation>`
 206
 207     * **Third-party distributions:**
 208       :ref:`Overview <misc-distributions>`
 209
 210     * **Django over time:**
 211       :ref:`API stability <misc-api-stability>` |
 212       :ref:`Release notes and upgrading instructions <releases-index>` |
 213       :ref:`Deprecation Timeline <internals-deprecation>`