test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documented ArchiveIndexView's date_list context variable. 

Refs #16218.
This commit is contained in:
Aymeric Augustin 2013-02-01 13:42:30 +01:00
parent 393c268e72
commit a0c67c69bf
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/ref/class-based-views/generic-date-based.txt
View File

@ -42,6 +42,20 @@ ArchiveIndexView
* :class:`django.views.generic.dates.DateMixin` * :class:`django.views.generic.dates.DateMixin`
* :class:`django.views.generic.base.View` * :class:`django.views.generic.base.View`
**Context**
In addition to the context provided by
:class:`django.views.generic.list.MultipleObjectMixin` (via
:class:`django.views.generic.dates.BaseDateListView`), the template's
context will be:
* ``date_list``: A
:meth:`DateQuerySet<django.db.models.query.QuerySet.dates>` object
containing all years that have objects available according to
``queryset``, represented as
:class:`datetime.datetime<python:datetime.datetime>` objects, in
descending order.
**Notes** **Notes**
* Uses a default ``context_object_name`` of ``latest``. * Uses a default ``context_object_name`` of ``latest``.
@ -109,7 +123,6 @@ YearArchiveView
Determine if an object list will be returned as part of the context. Determine if an object list will be returned as part of the context.
Returns :attr:`~YearArchiveView.make_object_list` by default. Returns :attr:`~YearArchiveView.make_object_list` by default.
**Context** **Context**
In addition to the context provided by In addition to the context provided by
@ -118,7 +131,7 @@ YearArchiveView
context will be: context will be:
* ``date_list``: A * ``date_list``: A
:meth:`DateQuerySet<django.db.models.query.QuerySet.dates>` object object :meth:`DateQuerySet<django.db.models.query.QuerySet.dates>` object
containing all months that have objects available according to containing all months that have objects available according to
``queryset``, represented as ``queryset``, represented as
:class:`datetime.datetime<python:datetime.datetime>` objects, in :class:`datetime.datetime<python:datetime.datetime>` objects, in