summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorKevin Kubasik <kevin@kubasik.net>2009-06-23 07:42:31 +0000
committerKevin Kubasik <kevin@kubasik.net>2009-06-23 07:42:31 +0000
commitb6b4a21cf59c78025d7825b483285eac2271ca1d (patch)
treea3a1398100482631106a767431d7a12b0451cd64 /docs/ref
parenta806b4a77a4740fd2d1d47558200c3f3bdb8d22b (diff)
r10900@kevin-kubasiks-macbook: kkubasik | 2009-06-23 01:39:08 -0600
[gsoc2009-testing] Merge last weeks work into SVN. Includes latests trunk and dozens of windmill tests. It is worth noting that the windmill tests are not included in coverage calculations git-svn-id: http://code.djangoproject.com/svn/django/branches/soc2009/test-improvements@11090 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/admin/index.txt2
-rw-r--r--docs/ref/contrib/contenttypes.txt4
-rw-r--r--docs/ref/django-admin.txt6
-rw-r--r--docs/ref/generic-views.txt72
-rw-r--r--docs/ref/index.txt1
-rw-r--r--docs/ref/models/querysets.txt2
-rw-r--r--docs/ref/settings.txt16
7 files changed, 31 insertions, 72 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index 6719527d2f..bad7dec390 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -347,7 +347,7 @@ A few special cases to note about ``list_display``:
birthday = models.DateField()
def born_in_fifties(self):
- return self.birthday.strftime('%Y')[:3] == 5
+ return self.birthday.strftime('%Y')[:3] == '195'
born_in_fifties.boolean = True
class PersonAdmin(admin.ModelAdmin):
diff --git a/docs/ref/contrib/contenttypes.txt b/docs/ref/contrib/contenttypes.txt
index f814eccaab..94900b3892 100644
--- a/docs/ref/contrib/contenttypes.txt
+++ b/docs/ref/contrib/contenttypes.txt
@@ -347,8 +347,8 @@ doesn't work with a
:class:`~django.contrib.contenttypes.generic.GenericRelation`. For example, you
might be tempted to try something like::
- Bookmark.objects.aggregate(Count('tags'))
-
+ Bookmark.objects.aggregate(Count('tags'))
+
This will not work correctly, however. The generic relation adds extra filters
to the queryset to ensure the correct content type, but the ``aggregate`` method
doesn't take them into account. For now, if you need aggregates on generic
diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt
index 71804cf022..f657db20f4 100644
--- a/docs/ref/django-admin.txt
+++ b/docs/ref/django-admin.txt
@@ -611,7 +611,11 @@ sqlsequencereset <appname appname ...>
Prints the SQL statements for resetting sequences for the given app name(s).
-See http://simon.incutio.com/archive/2004/04/21/postgres for more information.
+Sequences are indexes used by some database engines to track the next available
+number for automatically incremented fields.
+
+Use this command to generate SQL which will fix cases where a sequence is out
+of sync with its automatically incremented field data.
startapp <appname>
------------------
diff --git a/docs/ref/generic-views.txt b/docs/ref/generic-views.txt
index 427ef91090..4752a705a0 100644
--- a/docs/ref/generic-views.txt
+++ b/docs/ref/generic-views.txt
@@ -9,67 +9,18 @@ again and again. In Django, the most common of these patterns have been
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.
-
- * 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.).
+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.
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 @@ specify the page number in the URL in one of two ways:
/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 @@ As a special case, you are also permitted to use ``last`` as a value for
/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 @@ library <topics-forms-index>` to build and display the form.
**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:**
@@ -1137,3 +1088,4 @@ In addition to ``extra_context``, the template's context will be:
variable's name depends on the ``template_object_name`` parameter, which
is ``'object'`` by default. If ``template_object_name`` is ``'foo'``,
this variable's name will be ``foo``.
+
diff --git a/docs/ref/index.txt b/docs/ref/index.txt
index 3ffa1fcce1..6cc796d8e4 100644
--- a/docs/ref/index.txt
+++ b/docs/ref/index.txt
@@ -20,3 +20,4 @@ API Reference
signals
templates/index
unicode
+
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt
index 6c08fe079e..eb8fbfd833 100644
--- a/docs/ref/models/querysets.txt
+++ b/docs/ref/models/querysets.txt
@@ -616,6 +616,8 @@ call, since they are conflicting options.
Both the ``depth`` argument and the ability to specify field names in the call
to ``select_related()`` are new in Django version 1.0.
+.. _extra:
+
``extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 0cca6fe05d..e8c673d995 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -195,7 +195,7 @@ DATABASE_NAME
Default: ``''`` (Empty string)
The name of the database to use. For SQLite, it's the full path to the database
-file. When specifying the path, always use forward slashes, even on Windows
+file. When specifying the path, always use forward slashes, even on Windows
(e.g. ``C:/homes/user/mysite/sqlite3.db``).
.. setting:: DATABASE_OPTIONS
@@ -228,7 +228,7 @@ The port to use when connecting to the database. An empty string means the
default port. Not used with SQLite.
.. setting:: DATABASE_USER
-
+
DATABASE_USER
-------------
@@ -251,7 +251,7 @@ See also ``DATETIME_FORMAT``, ``TIME_FORMAT``, ``YEAR_MONTH_FORMAT``
and ``MONTH_DAY_FORMAT``.
.. setting:: DATETIME_FORMAT
-
+
DATETIME_FORMAT
---------------
@@ -330,7 +330,7 @@ isn't manually specified. Used with ``DEFAULT_CHARSET`` to construct the
DEFAULT_FILE_STORAGE
--------------------
-Default: ``django.core.files.storage.FileSystemStorage``
+Default: ``'django.core.files.storage.FileSystemStorage'``
Default file storage class to be used for any file-related operations that don't
specify a particular storage system. See :ref:`topics-files`.
@@ -519,14 +519,14 @@ system's standard umask.
.. warning::
**Always prefix the mode with a 0.**
-
+
If you're not familiar with file modes, please note that the leading
``0`` is very important: it indicates an octal number, which is the
way that modes must be specified. If you try to use ``644``, you'll
get totally incorrect behavior.
-
-.. _documentation for os.chmod: http://docs.python.org/lib/os-file-dir.html
+
+.. _documentation for os.chmod: http://docs.python.org/lib/os-file-dir.html
.. setting:: FIXTURE_DIRS
@@ -1153,7 +1153,7 @@ running in the correct environment.
Django cannot reliably use alternate time zones in a Windows environment.
If you're running Django on Windows, this variable must be set to match the
system timezone.
-
+
.. _See available choices: http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
.. setting:: URL_VALIDATOR_USER_AGENT