| 1 |
{% extends "base_docs.html" %} |
|---|
| 2 |
|
|---|
| 3 |
{% block content %} |
|---|
| 4 |
<h1>Documentation</h1> |
|---|
| 5 |
|
|---|
| 6 |
<h2 class="deck"> |
|---|
| 7 |
{% ifequal version "trunk" %} |
|---|
| 8 |
These docs are for Django's SVN release, which can be |
|---|
| 9 |
significantly different from previous releases. Get old docs here: |
|---|
| 10 |
{% for r in all_versions %} |
|---|
| 11 |
<a href="{{ r.version }}/">{{ r.version }}</a>{% if forloop.last %}.{% else %},{% endif %} |
|---|
| 12 |
{% endfor %} |
|---|
| 13 |
{% else %} |
|---|
| 14 |
These docs are for Django version {{ version }}. For current documentation, |
|---|
| 15 |
<a href="/documentation/">go here</a>. |
|---|
| 16 |
{% endifequal %} |
|---|
| 17 |
</h2> |
|---|
| 18 |
|
|---|
| 19 |
<h2>The Django Book</h2> |
|---|
| 20 |
|
|---|
| 21 |
<p>The Django Book is finished. You can read it for free at <a href="http://www.djangobook.com/">djangobook.com</a> or buy the print version. We recommend reading the first few chapters as your first introduction to Django.</p> |
|---|
| 22 |
|
|---|
| 23 |
<h2>The essential documentation</h2> |
|---|
| 24 |
|
|---|
| 25 |
<p>Make sure to read the following documentation. The rest (in the "Reference" section below) can be read in any particular order, as you need the various functionality.</p> |
|---|
| 26 |
|
|---|
| 27 |
<ul> |
|---|
| 28 |
<li><a href="overview/">Django overview</a></li> |
|---|
| 29 |
<li><a href="install/">Installation guide</a></li> |
|---|
| 30 |
<li>Tutorial: Writing your first Django app |
|---|
| 31 |
<ul> |
|---|
| 32 |
<li><a href="tutorial01/">Part 1: Initialization, creating models, the database API</a></li> |
|---|
| 33 |
<li><a href="tutorial02/">Part 2: Exploring the automatically-generated admin site</a></li> |
|---|
| 34 |
<li><a href="tutorial03/">Part 3: Creating the public interface views</a></li> |
|---|
| 35 |
<li><a href="tutorial04/">Part 4: Simple form processing and generic views</a></li> |
|---|
| 36 |
</ul> |
|---|
| 37 |
</li> |
|---|
| 38 |
<li><a href="faq/">Frequently asked questions (FAQ)</a></li> |
|---|
| 39 |
<li><a href="documentation/">How to read this documentation</a></li> |
|---|
| 40 |
</ul> |
|---|
| 41 |
|
|---|
| 42 |
<h2 id="reference">Reference</h2> |
|---|
| 43 |
|
|---|
| 44 |
<ul> |
|---|
| 45 |
<li><a href="django-admin/">The django-admin.py and manage.py utilities</a></li> |
|---|
| 46 |
<li>Models: <a href="model-api/">Creating models</a> | <a href="models/">Examples</a> | <a href="db-api/">The database API</a> | <a href="transactions/">Transactions</a></li> |
|---|
| 47 |
|
|---|
| 48 |
<li>Templates: <a href="templates/">Guide for HTML authors</a> | <a href="templates_python/">Guide for Python programmers</a></li> |
|---|
| 49 |
|
|---|
| 50 |
<li><a href="newforms/">The newforms library</a> | <a href="forms/">The old forms and manipulators library</a></li> |
|---|
| 51 |
<li><strong>New:</strong> <a href="testing/">Testing Django applications</a></li> |
|---|
| 52 |
<li><a href="sessions/">Sessions</a></li> |
|---|
| 53 |
<li><a href="cache/">Caching</a></li> |
|---|
| 54 |
<li><a href="i18n/">Internationalization</a></li> |
|---|
| 55 |
<li><a href="middleware/">Middleware</a></li> |
|---|
| 56 |
<li><a href="settings/">Settings files</a></li> |
|---|
| 57 |
<li><a href="url_dispatch/">URL configuration</a></li> |
|---|
| 58 |
<li><a href="request_response/">Request and response objects</a></li> |
|---|
| 59 |
<li><a href="generic_views/">Generic views</a></li> |
|---|
| 60 |
<li><a href="authentication/">Authentication</a></li> |
|---|
| 61 |
<li><a href="shortcuts/">Shortcut functions</a></li> |
|---|
| 62 |
<li><strong>New:</strong> <a href="unicode/">Unicode data in Django</a></li> |
|---|
| 63 |
<li><strong>New:</strong> <a href="pagination/">Pagination</a></li> |
|---|
| 64 |
|
|---|
| 65 |
<li><a href="add_ons/">The django.contrib add-ons</a> |
|---|
| 66 |
<ul> |
|---|
| 67 |
<li><a href="contenttypes/">Contenttypes Framework</a> (<code>django.contrib.contenttypes</code>)</li> |
|---|
| 68 |
<li><a href="csrf/">Cross Site Request Forgery protection</a> (<code>django.contrib.csrf</code>)</li> |
|---|
| 69 |
<li><a href="databrowse/">Databrowse</a> (<code>django.contrib.databrowse</code>)</li> |
|---|
| 70 |
<li><a href="flatpages/">Flatpages</a> (<code>django.contrib.flatpages</code>)</li> |
|---|
| 71 |
<li><strong>New:</strong> <a href="form_preview/">Form preview</a> (<code>django.contrib.formtools</code>)</li> |
|---|
| 72 |
<li><strong>New:</strong> <a href="form_wizard/">Form wizard</a> (<code>django.contrib.formtools.wizard</code>)</li> |
|---|
| 73 |
<li><a href="redirects/">Redirects</a> (<code>django.contrib.redirects</code>)</li> |
|---|
| 74 |
<li><a href="sites/">Sites</a> (<code>django.contrib.sites</code>)</li> |
|---|
| 75 |
<li><a href="sitemaps/">Sitemaps</a> (<code>django.contrib.sitemaps</code>)</li> |
|---|
| 76 |
<li><a href="syndication_feeds/">Syndication feeds (RSS and Atom)</a> (<code>django.contrib.syndication</code>)</li> |
|---|
| 77 |
<li><strong>New:</strong> <a href="webdesign/">Web design helpers</a> (<code>django.contrib.webdesign</code>)</li> |
|---|
| 78 |
</ul> |
|---|
| 79 |
</li> |
|---|
| 80 |
</ul> |
|---|
| 81 |
|
|---|
| 82 |
<h2>Deployment</h2> |
|---|
| 83 |
|
|---|
| 84 |
<ul> |
|---|
| 85 |
<li><a href="modpython/">Using Django with mod_python</a></li> |
|---|
| 86 |
<li><a href="fastcgi/">How to use Django with FastCGI, SCGI or AJP</a></li> |
|---|
| 87 |
</ul> |
|---|
| 88 |
|
|---|
| 89 |
<h2>Solving specific problems</h2> |
|---|
| 90 |
|
|---|
| 91 |
<ul> |
|---|
| 92 |
<li><a href="apache_auth/">Authenticating against Django's user database from Apache</a></li> |
|---|
| 93 |
<li><a href="static_files/">Serving static/media files</a></li> |
|---|
| 94 |
<li><a href="email/">Sending e-mail</a></li> |
|---|
| 95 |
<li><a href="legacy_databases/">Integrating with (introspecting) a legacy database</a></li> |
|---|
| 96 |
<li><a href="outputting_pdf/">Outputting PDFs dynamically</a></li> |
|---|
| 97 |
<li><a href="outputting_csv/">Outputting CSV dynamically</a></li> |
|---|
| 98 |
</ul> |
|---|
| 99 |
|
|---|
| 100 |
<h2>Et cetera</h2> |
|---|
| 101 |
<ul> |
|---|
| 102 |
<li><a href="design_philosophies/">Design philosophies</a></li> |
|---|
| 103 |
<li><a href="contributing/">How to contribute to Django</a></li> |
|---|
| 104 |
<li><a href="admin_css/">Django admin CSS guide</a></li> |
|---|
| 105 |
<li><a href="api_stability/">API stability</a></li> |
|---|
| 106 |
<li><a href="http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges">Backwards-incompatible changes</a></li> |
|---|
| 107 |
</ul> |
|---|
| 108 |
|
|---|
| 109 |
<h2>Release notes</h2> |
|---|
| 110 |
<ul> |
|---|
| 111 |
<li><a href="release_notes_0.96/">Version 0.96</a></li> |
|---|
| 112 |
<li><a href="release_notes_0.95/">Version 0.95</a></li> |
|---|
| 113 |
</ul> |
|---|
| 114 |
{% endblock %} |
|---|
| 115 |
|
|---|
| 116 |
{% block content-related %} |
|---|
| 117 |
|
|---|
| 118 |
<h2>Search docs via Google</h2> |
|---|
| 119 |
<form action="http://www.google.com/search" method="get"> |
|---|
| 120 |
<p><input type="text" name="as_q" /> <input type="submit" value="Go" /></p> |
|---|
| 121 |
<input type="hidden" name="as_sitesearch" value="www.djangoproject.com" /> |
|---|
| 122 |
</form> |
|---|
| 123 |
|
|---|
| 124 |
<h2>Getting help</h2> |
|---|
| 125 |
<ul class="toc"> |
|---|
| 126 |
<li><a href="irc://irc.freenode.net/django">#django IRC channel</a></li> |
|---|
| 127 |
<li><a href="http://oebfare.com/logger/django/">#django IRC logs</a></li> |
|---|
| 128 |
<li><a href="http://groups-beta.google.com/group/django-users">Django-users mailing list</a></li> |
|---|
| 129 |
<li><a href="http://groups-beta.google.com/group/django-developers">Django-developers mailing list</a></li> |
|---|
| 130 |
<li><a href="http://code.djangoproject.com/simpleticket">Report a bug</a></li> |
|---|
| 131 |
<li><a href="/comments/">Recent comments posted to djangoproject.com</a></li> |
|---|
| 132 |
</ul> |
|---|
| 133 |
|
|---|
| 134 |
{% endblock %} |
|---|