← Back to branch summary

~ubuntu-branches/ubuntu/quantal/python-django/quantal-security

« back to all changes in this revision

Viewing changes to docs/intro/overview.txt

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Strandboge
  • Date: 2010-10-12 11:34:35 UTC
  • mfrom: (1.1.12 upstream) (29.1.1 maverick-security)
  • Revision ID: james.westby@ubuntu.com-20101012113435-yy57c8tx6g9anf3e
Tags: 1.2.3-1ubuntu0.1
* SECURITY UPDATE: XSS in CSRF protections. New upstream release
  - CVE-2010-3082
* debian/patches/01_disable_url_verify_regression_tests.diff:
  - updated to disable another test that fails without internet connection
  - patch based on work by Kai Kasurinen and Krzysztof Klimonda
* debian/control: don't Build-Depends on locales-all, which doesn't exist
  in maverick

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/intro/overview.txt
1
 
.. _intro-overview:
2
 
 
3
1
==================
4
2
Django at a glance
5
3
==================
11
9
The goal of this document is to give you enough technical specifics to
12
10
understand how Django works, but this isn't intended to be a tutorial or
13
11
reference -- but we've got both! When you're ready to start a project, you can
14
 
:ref:`start with the tutorial <intro-tutorial01>` or :ref:`dive right into more
15
 
detailed documentation <topics-index>`.
 
12
:doc:`start with the tutorial </intro/tutorial01>` or :doc:`dive right into more
 
13
detailed documentation </topics/index>`.
16
14
 
17
15
Design your model
18
16
=================
21
19
object-relational mapper in which you describe your database layout in Python
22
20
code.
23
21
 
24
 
The :ref:`data-model syntax <topics-db-models>` offers many rich ways of
 
22
The :doc:`data-model syntax </topics/db/models>` offers many rich ways of
25
23
representing your models -- so far, it's been solving two years' worth of
26
24
database-schema problems. Here's a quick example::
27
25
 
56
54
Enjoy the free API
57
55
==================
58
56
 
59
 
With that, you've got a free, and rich, :ref:`Python API <topics-db-queries>` to
 
57
With that, you've got a free, and rich, :doc:`Python API </topics/db/queries>` to
60
58
access your data. The API is created on the fly, no code generation necessary::
61
59
 
62
60
    >>> from mysite.models import Reporter, Article
131
129
============================================================================
132
130
 
133
131
Once your models are defined, Django can automatically create a professional,
134
 
production ready :ref:`administrative interface <ref-contrib-admin>` -- a Web
 
132
production ready :doc:`administrative interface </ref/contrib/admin/index>` -- a Web
135
133
site that lets authenticated users add, change and delete objects. It's as easy
136
134
as registering your model in the admin site::
137
135
 
168
166
application. Django encourages beautiful URL design and doesn't put any cruft
169
167
in URLs, like ``.php`` or ``.asp``.
170
168
 
171
 
To design URLs for an app, you create a Python module called a :ref:`URLconf
172
 
<topics-http-urls>`. A table of contents for your app, it contains a simple mapping
 
169
To design URLs for an app, you create a Python module called a :doc:`URLconf
 
170
</topics/http/urls>`. A table of contents for your app, it contains a simple mapping
173
171
between URL patterns and Python callback functions. URLconfs also serve to
174
172
decouple URLs from Python code.
175
173
 
216
214
        a_list = Article.objects.filter(pub_date__year=year)
217
215
        return render_to_response('news/year_archive.html', {'year': year, 'article_list': a_list})
218
216
 
219
 
This example uses Django's :ref:`template system <topics-templates>`, which has
 
217
This example uses Django's :doc:`template system </topics/templates>`, which has
220
218
several powerful features but strives to stay simple enough for non-programmers
221
219
to use.
222
220
 
307
305
This has been only a quick overview of Django's functionality. Some more useful
308
306
features:
309
307
 
310
 
    * A :ref:`caching framework <topics-cache>` that integrates with memcached
 
308
    * A :doc:`caching framework </topics/cache>` that integrates with memcached
311
309
      or other backends.
312
310
 
313
 
    * A :ref:`syndication framework <ref-contrib-syndication>` that makes
 
311
    * A :doc:`syndication framework </ref/contrib/syndication>` that makes
314
312
      creating RSS and Atom feeds as easy as writing a small Python class.
315
313
 
316
314
    * More sexy automatically-generated admin features -- this overview barely
317
315
      scratched the surface.
318
316
 
319
 
The next obvious steps are for you to `download Django`_, read :ref:`the
320
 
tutorial <intro-tutorial01>` and join `the community`_. Thanks for your
 
317
The next obvious steps are for you to `download Django`_, read :doc:`the
 
318
tutorial </intro/tutorial01>` and join `the community`_. Thanks for your
321
319
interest!
322
320
 
323
321
.. _download Django: http://www.djangoproject.com/download/