Author: russellm
Date: 2009-06-17 09:09:56 -0500 (Wed, 17 Jun 2009)
New Revision: 11025
Modified:
django/trunk/docs/index.txt
django/trunk/docs/internals/documentation.txt
django/trunk/docs/ref/generic-views.txt
django/trunk/docs/topics/index.txt
Log:
Fixed #10336 -- Added improved documentation of generic views. Thanks to Jacob
and Adrian for the original text (from the DjangoBook), and Ramiro for doing
the work of porting the docs.
Modified: django/trunk/docs/index.txt
===================================================================
--- django/trunk/docs/index.txt 2009-06-17 13:54:43 UTC (rev 11024)
+++ django/trunk/docs/index.txt 2009-06-17 14:09:56 UTC (rev 11025)
@@ -98,10 +98,13 @@
:ref:`Storage API <ref-files-storage>` |
:ref:`Managing files <topics-files>` |
:ref:`Custom storage <howto-custom-file-storage>`
-
- * **Advanced:**
- :ref:`Generic views <ref-generic-views>` |
- :ref:`Generating CSV <howto-outputting-csv>` |
+
+ * **Generic views:**
+ :ref:`Overview<topics-generic-views>` |
+ :ref:`Built-in generic views<ref-generic-views>`
+
+ * **Advanced:**
+ :ref:`Generating CSV <howto-outputting-csv>` |
:ref:`Generating PDF <howto-outputting-pdf>`
* **Middleware:**
Modified: django/trunk/docs/internals/documentation.txt
===================================================================
--- django/trunk/docs/internals/documentation.txt 2009-06-17 13:54:43 UTC
(rev 11024)
+++ django/trunk/docs/internals/documentation.txt 2009-06-17 14:09:56 UTC
(rev 11025)
@@ -130,11 +130,6 @@
The work is mostly done, but here's what's left, in rough order of priority.
- * Fix up generic view docs: adapt Chapter 9 of the Django Book (consider
- this TODO item my permission and license) into
- ``topics/generic-views.txt``; remove the intro material from
- ``ref/generic-views.txt`` and just leave the function reference.
-
* Change the "Added/changed in development version" callouts to proper
Sphinx ``.. versionadded::`` or ``.. versionchanged::`` directives.
Modified: django/trunk/docs/ref/generic-views.txt
===================================================================
--- django/trunk/docs/ref/generic-views.txt 2009-06-17 13:54:43 UTC (rev
11024)
+++ django/trunk/docs/ref/generic-views.txt 2009-06-17 14:09:56 UTC (rev
11025)
@@ -9,67 +9,18 @@
abstracted into "generic views" that let you quickly provide common views of
an object without actually needing to write any Python code.
-Django's generic views contain the following:
+A general introduction to generic views can be found in the :ref:`topic guide
+<topics-generic-views>`.
- * A set of views for doing list/detail interfaces.
+This reference contains details of Django's built-in generic views, along with
+a list of all keyword arguments that a generic view expects. Remember that
+arguments may either come from the URL pattern or from the ``extra_context``
+additional-information dictionary.
- * A set of views for year/month/day archive pages and associated
- detail and "latest" pages (for example, the Django weblog's year_,
- month_, day_, detail_, and latest_ pages).
-
- * A set of views for creating, editing, and deleting objects.
-
-.. _year: http://www.djangoproject.com/weblog/2005/
-.. _month: http://www.djangoproject.com/weblog/2005/jul/
-.. _day: http://www.djangoproject.com/weblog/2005/jul/20/
-.. _detail: http://www.djangoproject.com/weblog/2005/jul/20/autoreload/
-.. _latest: http://www.djangoproject.com/weblog/
-
-All of these views are used by creating configuration dictionaries in
-your URLconf files and passing those dictionaries as the third member of the
-URLconf tuple for a given pattern. For example, here's the URLconf for the
-simple weblog app that drives the blog on djangoproject.com::
-
- from django.conf.urls.defaults import *
- from django_website.apps.blog.models import Entry
-
- info_dict = {
- 'queryset': Entry.objects.all(),
- 'date_field': 'pub_date',
- }
-
- urlpatterns = patterns('django.views.generic.date_based',
-
(r'^(?P<year>\d{4})/(?P<month>[a-z]{3})/(?P<day>\w{1,2})/(?P<slug>[-\w]+)/$',
'object_detail', info_dict),
- (r'^(?P<year>\d{4})/(?P<month>[a-z]{3})/(?P<day>\w{1,2})/$',
'archive_day', info_dict),
- (r'^(?P<year>\d{4})/(?P<month>[a-z]{3})/$',
'archive_month', info_dict),
- (r'^(?P<year>\d{4})/$',
'archive_year', info_dict),
- (r'^$',
'archive_index', info_dict),
- )
-
-As you can see, this URLconf defines a few options in ``info_dict``.
-``'queryset'`` gives the generic view a ``QuerySet`` of objects to use (in this
-case, all of the ``Entry`` objects) and tells the generic view which model is
-being used.
-
-Documentation of each generic view follows, along with a list of all keyword
-arguments that a generic view expects. Remember that as in the example above,
-arguments may either come from the URL pattern (as ``month``, ``day``,
-``year``, etc. do above) or from the additional-information dictionary (as for
-``queryset``, ``date_field``, etc.).
-
Most generic views require the ``queryset`` key, which is a ``QuerySet``
instance; see :ref:`topics-db-queries` for more information about ``QuerySet``
objects.
-Most views also take an optional ``extra_context`` dictionary that you can use
-to pass any auxiliary information you wish to the view. The values in the
-``extra_context`` dictionary can be either functions (or other callables) or
-other objects. Functions are evaluated just before they are passed to the
-template. However, note that QuerySets retrieve and cache their data when they
-are first evaluated, so if you want to pass in a QuerySet via
-``extra_context`` that is always fresh you need to wrap it in a function or
-lambda that returns the QuerySet.
-
"Simple" generic views
======================
@@ -801,12 +752,12 @@
/objects/?page=3
- * To loop over all the available page numbers, use the ``page_range``
- variable. You can iterate over the list provided by ``page_range``
+ * To loop over all the available page numbers, use the ``page_range``
+ variable. You can iterate over the list provided by ``page_range``
to create a link to every page of results.
These values and lists are 1-based, not 0-based, so the first page would be
-represented as page ``1``.
+represented as page ``1``.
For more on pagination, read the :ref:`pagination documentation
<topics-pagination>`.
@@ -818,7 +769,7 @@
/objects/?page=last
-This allows you to access the final page of results without first having to
+This allows you to access the final page of results without first having to
determine how many pages there are.
Note that ``page`` *must* be either a valid page number or the value ``last``;
@@ -909,7 +860,7 @@
**Description:**
A page that displays a form for creating an object, redisplaying the form with
-validation errors (if there are any) and saving the object.
+validation errors (if there are any) and saving the object.
**Required arguments:**
Modified: django/trunk/docs/topics/index.txt
===================================================================
--- django/trunk/docs/topics/index.txt 2009-06-17 13:54:43 UTC (rev 11024)
+++ django/trunk/docs/topics/index.txt 2009-06-17 14:09:56 UTC (rev 11025)
@@ -14,6 +14,7 @@
forms/index
forms/modelforms
templates
+ generic-views
files
testing
auth
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
