|
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://botland.oebfare.com/logger/django/ |
|
32 .. _ticket tracker: http://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 |
|
96 * **Reference:** :doc:`Request/response objects <ref/request-response>` |
|
97 |
|
98 * **File uploads:** |
|
99 :doc:`Overview <topics/http/file-uploads>` | |
|
100 :doc:`File objects <ref/files/file>` | |
|
101 :doc:`Storage API <ref/files/storage>` | |
|
102 :doc:`Managing files <topics/files>` | |
|
103 :doc:`Custom storage <howto/custom-file-storage>` |
|
104 |
|
105 * **Generic views:** |
|
106 :doc:`Overview<topics/generic-views>` | |
|
107 :doc:`Built-in generic views<ref/generic-views>` |
|
108 |
|
109 * **Advanced:** |
|
110 :doc:`Generating CSV <howto/outputting-csv>` | |
|
111 :doc:`Generating PDF <howto/outputting-pdf>` |
|
112 |
|
113 * **Middleware:** |
|
114 :doc:`Overview <topics/http/middleware>` | |
|
115 :doc:`Built-in middleware classes <ref/middleware>` |
|
116 |
|
117 Forms |
|
118 ===== |
|
119 |
|
120 * **The basics:** |
|
121 :doc:`Overview <topics/forms/index>` | |
|
122 :doc:`Form API <ref/forms/api>` | |
|
123 :doc:`Built-in fields <ref/forms/fields>` | |
|
124 :doc:`Built-in widgets <ref/forms/widgets>` |
|
125 |
|
126 * **Advanced:** |
|
127 :doc:`Forms for models <topics/forms/modelforms>` | |
|
128 :doc:`Integrating media <topics/forms/media>` | |
|
129 :doc:`Formsets <topics/forms/formsets>` | |
|
130 :doc:`Customizing validation <ref/forms/validation>` |
|
131 |
|
132 * **Extras:** |
|
133 :doc:`Form preview <ref/contrib/formtools/form-preview>` | |
|
134 :doc:`Form wizard <ref/contrib/formtools/form-wizard>` |
|
135 |
|
136 The development process |
|
137 ======================= |
|
138 |
|
139 * **Settings:** |
|
140 :doc:`Overview <topics/settings>` | |
|
141 :doc:`Full list of settings <ref/settings>` |
|
142 |
|
143 * **Exceptions:** |
|
144 :doc:`Overview <ref/exceptions>` |
|
145 |
|
146 * **django-admin.py and manage.py:** |
|
147 :doc:`Overview <ref/django-admin>` | |
|
148 :doc:`Adding custom commands <howto/custom-management-commands>` |
|
149 |
|
150 * **Testing:** :doc:`Overview <topics/testing>` |
|
151 |
|
152 * **Deployment:** |
|
153 :doc:`Overview <howto/deployment/index>` | |
|
154 :doc:`Apache/mod_wsgi <howto/deployment/modwsgi>` | |
|
155 :doc:`Apache/mod_python <howto/deployment/modpython>` | |
|
156 :doc:`FastCGI/SCGI/AJP <howto/deployment/fastcgi>` | |
|
157 :doc:`Apache authentication <howto/apache-auth>` | |
|
158 :doc:`Serving static files <howto/static-files>` | |
|
159 :doc:`Tracking code errors by e-mail <howto/error-reporting>` |
|
160 |
|
161 Other batteries included |
|
162 ======================== |
|
163 |
|
164 * :doc:`Admin site <ref/contrib/admin/index>` | :doc:`Admin actions <ref/contrib/admin/actions>` | :doc:`Admin documentation generator<ref/contrib/admin/admindocs>` |
|
165 * :doc:`Authentication <topics/auth>` |
|
166 * :doc:`Cache system <topics/cache>` |
|
167 * :doc:`Conditional content processing <topics/conditional-view-processing>` |
|
168 * :doc:`Comments <ref/contrib/comments/index>` | :doc:`Moderation <ref/contrib/comments/moderation>` | :doc:`Custom comments <ref/contrib/comments/custom>` |
|
169 * :doc:`Content types <ref/contrib/contenttypes>` |
|
170 * :doc:`Cross Site Request Forgery protection <ref/contrib/csrf>` |
|
171 * :doc:`Databrowse <ref/contrib/databrowse>` |
|
172 * :doc:`E-mail (sending) <topics/email>` |
|
173 * :doc:`Flatpages <ref/contrib/flatpages>` |
|
174 * :doc:`GeoDjango <ref/contrib/gis/index>` |
|
175 * :doc:`Humanize <ref/contrib/humanize>` |
|
176 * :doc:`Internationalization <topics/i18n/index>` |
|
177 * :doc:`Jython support <howto/jython>` |
|
178 * :doc:`"Local flavor" <ref/contrib/localflavor>` |
|
179 * :doc:`Messages <ref/contrib/messages>` |
|
180 * :doc:`Pagination <topics/pagination>` |
|
181 * :doc:`Redirects <ref/contrib/redirects>` |
|
182 * :doc:`Serialization <topics/serialization>` |
|
183 * :doc:`Sessions <topics/http/sessions>` |
|
184 * :doc:`Signals <topics/signals>` |
|
185 * :doc:`Sitemaps <ref/contrib/sitemaps>` |
|
186 * :doc:`Sites <ref/contrib/sites>` |
|
187 * :doc:`Syndication feeds (RSS/Atom) <ref/contrib/syndication>` |
|
188 * :doc:`Unicode in Django <ref/unicode>` |
|
189 * :doc:`Web design helpers <ref/contrib/webdesign>` |
|
190 * :doc:`Validators <ref/validators>` |
|
191 |
|
192 The Django open-source project |
|
193 ============================== |
|
194 |
|
195 * **Community:** |
|
196 :doc:`How to get involved <internals/contributing>` | |
|
197 :doc:`The release process <internals/release-process>` | |
|
198 :doc:`Team of committers <internals/committers>` | |
|
199 :doc:`The Django source code repository <internals/svn>` |
|
200 |
|
201 * **Design philosophies:** |
|
202 :doc:`Overview <misc/design-philosophies>` |
|
203 |
|
204 * **Documentation:** |
|
205 :doc:`About this documentation <internals/documentation>` |
|
206 |
|
207 * **Third-party distributions:** |
|
208 :doc:`Overview <misc/distributions>` |
|
209 |
|
210 * **Django over time:** |
|
211 :doc:`API stability <misc/api-stability>` | |
|
212 :doc:`Release notes and upgrading instructions <releases/index>` | |
|
213 :doc:`Deprecation Timeline <internals/deprecation>` |