Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Used definition lists to be consistent with other docs. Also used 3rd…

…-level headings instead of bold text.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8196 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 1b1b8d097100f88c537a589cac678c657048a417 1 parent 52b877e
Gary Wilson Jr. authored August 03, 2008

Showing 1 changed file with 689 additions and 534 deletions. Show diff stats Hide diff stats

  1. 1,223  docs/generic_views.txt
1,223  docs/generic_views.txt
@@ -83,24 +83,29 @@ and issuing a redirect.
83 83
 ``django.views.generic.simple.direct_to_template``
84 84
 --------------------------------------------------
85 85
 
86  
-**Description:**
  86
+Description
  87
+~~~~~~~~~~~
87 88
 
88 89
 Renders a given template, passing it a ``{{ params }}`` template variable,
89 90
 which is a dictionary of the parameters captured in the URL.
90 91
 
91  
-**Required arguments:**
  92
+Required arguments
  93
+~~~~~~~~~~~~~~~~~~
92 94
 
93  
-    * ``template``: The full name of a template to use.
  95
+``template``
  96
+    The full name of a template to use.
94 97
 
95  
-**Optional arguments:**
  98
+Optional arguments
  99
+~~~~~~~~~~~~~~~~~~
96 100
 
97  
-    * ``extra_context``: A dictionary of values to add to the template
98  
-      context. By default, this is an empty dictionary. If a value in the
99  
-      dictionary is callable, the generic view will call it
100  
-      just before rendering the template.
  101
+``extra_context``
  102
+    A dictionary of values to add to the template context. By default, this is
  103
+    an empty dictionary. If a value in the dictionary is callable, the generic
  104
+    view will call it just before rendering the template.
101 105
 
102  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
103  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  106
+``mimetype``
  107
+    The MIME type to use for the resulting document. Defaults to the value of
  108
+    the ``DEFAULT_CONTENT_TYPE`` setting.
104 109
 
105 110
 **Example:**
106 111
 
@@ -118,7 +123,8 @@ variable ``{{ params.id }}`` that is set to ``15``.
118 123
 ``django.views.generic.simple.redirect_to``
119 124
 -------------------------------------------
120 125
 
121  
-**Description:**
  126
+Description
  127
+~~~~~~~~~~~
122 128
 
123 129
 Redirects to a given URL.
124 130
 
@@ -127,10 +133,12 @@ interpolated against the parameters captured in the URL.
127 133
 
128 134
 If the given URL is ``None``, Django will return an ``HttpResponseGone`` (410).
129 135
 
130  
-**Required arguments:**
  136
+Required arguments
  137
+~~~~~~~~~~~~~~~~~~
131 138
 
132  
-    * ``url``: The URL to redirect to, as a string. Or ``None`` to raise a 410
133  
-      (Gone) HTTP error.
  139
+``url``
  140
+    The URL to redirect to, as a string. Or ``None`` to raise a 410 (Gone)
  141
+    HTTP error.
134 142
 
135 143
 **Example:**
136 144
 
@@ -155,57 +163,69 @@ are views for displaying drilldown pages for date-based data.
155 163
 ``django.views.generic.date_based.archive_index``
156 164
 -------------------------------------------------
157 165
 
158  
-**Description:**
  166
+Description
  167
+~~~~~~~~~~~
159 168
 
160 169
 A top-level index page showing the "latest" objects, by date. Objects with
161 170
 a date in the *future* are not included unless you set ``allow_future`` to
162 171
 ``True``.
163 172
 
164  
-**Required arguments:**
  173
+Required arguments
  174
+~~~~~~~~~~~~~~~~~~
165 175
 
166  
-    * ``queryset``: A ``QuerySet`` of objects for which the archive serves.
  176
+``queryset``
  177
+    A ``QuerySet`` of objects for which the archive serves.
167 178
 
168  
-    * ``date_field``: The name of the ``DateField`` or ``DateTimeField`` in
169  
-      the ``QuerySet``'s model that the date-based archive should use to
170  
-      determine the objects on the page.
  179
+``date_field``
  180
+    The name of the ``DateField`` or ``DateTimeField`` in the ``QuerySet``'s
  181
+    model that the date-based archive should use to determine the objects on
  182
+    the page.
171 183
 
172  
-**Optional arguments:**
  184
+Optional arguments
  185
+~~~~~~~~~~~~~~~~~~
173 186
 
174  
-    * ``num_latest``: The number of latest objects to send to the template
175  
-      context. By default, it's 15.
  187
+``num_latest``
  188
+    The number of latest objects to send to the template context. By default,
  189
+    it's 15.
176 190
 
177  
-    * ``template_name``: The full name of a template to use in rendering the
178  
-      page. This lets you override the default template name (see below).
  191
+``template_name``
  192
+    The full name of a template to use in rendering the page. This lets you
  193
+    override the default template name (see below).
179 194
 
180  
-    * ``template_loader``: The template loader to use when loading the
181  
-      template. By default, it's ``django.template.loader``.
  195
+``template_loader``
  196
+    The template loader to use when loading the template. By default, it's
  197
+    ``django.template.loader``.
182 198
 
183  
-    * ``extra_context``: A dictionary of values to add to the template
184  
-      context. By default, this is an empty dictionary. If a value in the
185  
-      dictionary is callable, the generic view will call it
186  
-      just before rendering the template.
  199
+``extra_context``
  200
+    A dictionary of values to add to the template context. By default, this is
  201
+    an empty dictionary. If a value in the dictionary is callable, the generic
  202
+    view will call it just before rendering the template.
187 203
 
188  
-    * ``allow_empty``: A boolean specifying whether to display the page if no
189  
-      objects are available. If this is ``False`` and no objects are available,
190  
-      the view will raise a 404 instead of displaying an empty page. By
191  
-      default, this is ``True``.
  204
+``allow_empty``
  205
+    A boolean specifying whether to display the page if no objects are
  206
+    available. If this is ``False`` and no objects are available, the view will
  207
+    raise a 404 instead of displaying an empty page. By default, this is
  208
+    ``True``.
192 209
 
193  
-    * ``context_processors``: A list of template-context processors to apply to
194  
-      the view's template. See the `RequestContext docs`_.
  210
+``context_processors``
  211
+    A list of template-context processors to apply to the view's template. See
  212
+    the `RequestContext docs`_.
195 213
 
196  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
197  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  214
+``mimetype``
  215
+    The MIME type to use for the resulting document. Defaults to the value of
  216
+    the ``DEFAULT_CONTENT_TYPE`` setting.
198 217
 
199  
-    * ``allow_future``: A boolean specifying whether to include "future"
200  
-      objects on this page, where "future" means objects in which the field
201  
-      specified in ``date_field`` is greater than the current date/time. By
202  
-      default, this is ``False``.
  218
+``allow_future``
  219
+    A boolean specifying whether to include "future" objects on this page,
  220
+    where "future" means objects in which the field specified in ``date_field``
  221
+    is greater than the current date/time. By default, this is ``False``.
203 222
 
204  
-    * **New in Django development version:** ``template_object_name``:
205  
-      Designates the name of the template variable to use in the template
206  
-      context. By default, this is ``'latest'``.
  223
+``template_object_name`` (**New in Django development version**)
  224
+    Designates the name of the template variable to use in the template
  225
+    context. By default, this is ``'latest'``.
207 226
 
208  
-**Template name:**
  227
+Template name
  228
+~~~~~~~~~~~~~
209 229
 
210 230
 If ``template_name`` isn't specified, this view will use the template
211 231
 ``<app_label>/<model_name>_archive.html`` by default, where:
@@ -217,365 +237,435 @@ If ``template_name`` isn't specified, this view will use the template
217 237
       your model's app. For example, if your model lives in
218 238
       ``apps/blog/models.py``, that'd be ``blog``.
219 239
 
220  
-**Template context:**
  240
+Template context
  241
+~~~~~~~~~~~~~~~~
221 242
 
222 243
 In addition to ``extra_context``, the template's context will be:
223 244
 
224  
-    * ``date_list``: A list of ``datetime.date`` objects representing all
225  
-      years that have objects available according to ``queryset``. These are
226  
-      ordered in reverse. This is equivalent to
227  
-      ``queryset.dates(date_field, 'year')[::-1]``.
  245
+``date_list``
  246
+    A list of ``datetime.date`` objects representing all years that have
  247
+    objects available according to ``queryset``. These are ordered in reverse.
  248
+    This is equivalent to ``queryset.dates(date_field, 'year')[::-1]``.
228 249
 
229  
-    * ``latest``: The ``num_latest`` objects in the system, ordered descending
230  
-      by ``date_field``. For example, if ``num_latest`` is ``10``, then
231  
-      ``latest`` will be a list of the latest 10 objects in ``queryset``.
  250
+``latest``
  251
+    The ``num_latest`` objects in the system, ordered descending by
  252
+    ``date_field``. For example, if ``num_latest`` is ``10``, then ``latest``
  253
+    will be a list of the latest 10 objects in ``queryset``.
232 254
 
233  
-      **New in Django development version:** This variable's name depends on
234  
-      the ``template_object_name`` parameter, which is ``'latest'`` by default.
235  
-      If ``template_object_name`` is ``'foo'``, this variable's name will be
236  
-      ``foo``.
  255
+    **New in Django development version:** This variable's name depends on the
  256
+    ``template_object_name`` parameter, which is ``'latest'`` by default.
  257
+    If ``template_object_name`` is ``'foo'``, this variable's name will be
  258
+    ``foo``.
237 259
 
238 260
 .. _RequestContext docs: ../templates_python/#subclassing-context-requestcontext
239 261
 
240 262
 ``django.views.generic.date_based.archive_year``
241 263
 ------------------------------------------------
242 264
 
243  
-**Description:**
  265
+Description
  266
+~~~~~~~~~~~
244 267
 
245 268
 A yearly archive page showing all available months in a given year. Objects
246 269
 with a date in the *future* are not displayed unless you set ``allow_future``
247 270
 to ``True``.
248 271
 
249  
-**Required arguments:**
  272
+Required arguments
  273
+~~~~~~~~~~~~~~~~~~
250 274
 
251  
-    * ``year``: The four-digit year for which the archive serves.
  275
+``year``
  276
+    The four-digit year for which the archive serves.
252 277
 
253  
-    * ``queryset``: A ``QuerySet`` of objects for which the archive serves.
  278
+``queryset``
  279
+    A ``QuerySet`` of objects for which the archive serves.
254 280
 
255  
-    * ``date_field``: The name of the ``DateField`` or ``DateTimeField`` in
256  
-      the ``QuerySet``'s model that the date-based archive should use to
257  
-      determine the objects on the page.
  281
+``date_field``
  282
+    The name of the ``DateField`` or ``DateTimeField`` in the ``QuerySet``'s
  283
+    model that the date-based archive should use to determine the objects on
  284
+    the page.
258 285
 
259  
-**Optional arguments:**
  286
+Optional arguments
  287
+~~~~~~~~~~~~~~~~~~
260 288
 
261  
-    * ``template_name``: The full name of a template to use in rendering the
262  
-      page. This lets you override the default template name (see below).
  289
+``template_name``
  290
+    The full name of a template to use in rendering the page. This lets you
  291
+    override the default template name (see below).
263 292
 
264  
-    * ``template_loader``: The template loader to use when loading the
265  
-      template. By default, it's ``django.template.loader``.
  293
+``template_loader``
  294
+    The template loader to use when loading the template. By default, it's
  295
+    ``django.template.loader``.
266 296
 
267  
-    * ``extra_context``: A dictionary of values to add to the template
268  
-      context. By default, this is an empty dictionary. If a value in the
269  
-      dictionary is callable, the generic view will call it
270  
-      just before rendering the template.
  297
+``extra_context``
  298
+    A dictionary of values to add to the template context. By default, this is
  299
+    an empty dictionary. If a value in the dictionary is callable, the generic
  300
+    view will call it just before rendering the template.
271 301
 
272  
-    * ``allow_empty``: A boolean specifying whether to display the page if no
273  
-      objects are available. If this is ``False`` and no objects are available,
274  
-      the view will raise a 404 instead of displaying an empty page. By
275  
-      default, this is ``False``.
  302
+``allow_empty``
  303
+    A boolean specifying whether to display the page if no objects are
  304
+    available. If this is ``False`` and no objects are available, the view will
  305
+    raise a 404 instead of displaying an empty page. By default, this is
  306
+    ``False``.
276 307
 
277  
-    * ``context_processors``: A list of template-context processors to apply to
278  
-      the view's template. See the `RequestContext docs`_.
  308
+``context_processors``
  309
+    A list of template-context processors to apply to the view's template. See
  310
+    the `RequestContext docs`_.
279 311
 
280  
-    * ``template_object_name``:  Designates the name of the template variable
281  
-      to use in the template context. By default, this is ``'object'``. The
282  
-      view will append ``'_list'`` to the value of this parameter in
283  
-      determining the variable's name.
  312
+``template_object_name``
  313
+    Designates the name of the template variable to use in the template
  314
+    context. By default, this is ``'object'``. The view will append ``'_list'``
  315
+    to the value of this parameter in determining the variable's name.
284 316
 
285  
-    * ``make_object_list``: A boolean specifying whether to retrieve the full
286  
-      list of objects for this year and pass those to the template. If ``True``,
287  
-      this list of objects will be made available to the template as
288  
-      ``object_list``. (The name ``object_list`` may be different; see the docs
289  
-      for ``object_list`` in the "Template context" section below.) By default,
290  
-      this is ``False``.
  317
+``make_object_list``
  318
+    A boolean specifying whether to retrieve the full  list of objects for this
  319
+    year and pass those to the template. If ``True``, this list of objects will
  320
+    be made available to the template as ``object_list``. (The name
  321
+    ``object_list`` may be different; see the docs for ``object_list`` in the
  322
+    "Template context" section below.) By default, this is ``False``.
291 323
 
292  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
293  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  324
+``mimetype``
  325
+    The MIME type to use for the resulting document. Defaults to the value of
  326
+    the ``DEFAULT_CONTENT_TYPE`` setting.
294 327
 
295  
-    * ``allow_future``: A boolean specifying whether to include "future"
296  
-      objects on this page, where "future" means objects in which the field
297  
-      specified in ``date_field`` is greater than the current date/time. By
298  
-      default, this is ``False``.
  328
+``allow_future``
  329
+    A boolean specifying whether to include "future" objects on this page,
  330
+    where "future" means objects in which the field specified in ``date_field``
  331
+    is greater than the current date/time. By default, this is ``False``.
299 332
 
300  
-**Template name:**
  333
+Template name
  334
+~~~~~~~~~~~~~
301 335
 
302 336
 If ``template_name`` isn't specified, this view will use the template
303 337
 ``<app_label>/<model_name>_archive_year.html`` by default.
304 338
 
305  
-**Template context:**
  339
+Template context
  340
+~~~~~~~~~~~~~~~~
306 341
 
307 342
 In addition to ``extra_context``, the template's context will be:
308 343
 
309  
-    * ``date_list``: A list of ``datetime.date`` objects representing all
310  
-      months that have objects available in the given year, according to
311  
-      ``queryset``, in ascending order.
  344
+``date_list``
  345
+    A list of ``datetime.date`` objects representing all months that have
  346
+    objects available in the given year, according to ``queryset``, in
  347
+    ascending order.
312 348
 
313  
-    * ``year``: The given year, as a four-character string.
  349
+``year``
  350
+    The given year, as a four-character string.
314 351
 
315  
-    * ``object_list``: If the ``make_object_list`` parameter is ``True``, this
316  
-      will be set to a list of objects available for the given year, ordered by
317  
-      the date field. This variable's name depends on the
318  
-      ``template_object_name`` parameter, which is ``'object'`` by default. If
319  
-      ``template_object_name`` is ``'foo'``, this variable's name will be
320  
-      ``foo_list``.
  352
+``object_list``
  353
+    If the ``make_object_list`` parameter is ``True``, this will be set to a
  354
+    list of objects available for the given year, ordered by the date field.
  355
+    This variable's name depends on the ``template_object_name`` parameter,
  356
+    which is ``'object'`` by default. If ``template_object_name`` is ``'foo'``,
  357
+    this variable's name will be ``foo_list``.
321 358
 
322  
-      If ``make_object_list`` is ``False``, ``object_list`` will be passed to
323  
-      the template as an empty list.
  359
+    If ``make_object_list`` is ``False``, ``object_list`` will be passed to the
  360
+    template as an empty list.
324 361
 
325 362
 ``django.views.generic.date_based.archive_month``
326 363
 -------------------------------------------------
327 364
 
328  
-**Description:**
  365
+Description
  366
+~~~~~~~~~~~
329 367
 
330 368
 A monthly archive page showing all objects in a given month. Objects with a
331 369
 date in the *future* are not displayed unless you set ``allow_future`` to
332 370
 ``True``.
333 371
 
334  
-**Required arguments:**
  372
+Required arguments
  373
+~~~~~~~~~~~~~~~~~~
335 374
 
336  
-    * ``year``: The four-digit year for which the archive serves (a string).
  375
+``year``
  376
+    The four-digit year for which the archive serves (a string).
337 377
 
338  
-    * ``month``: The month for which the archive serves, formatted according to
339  
-      the ``month_format`` argument.
  378
+``month``
  379
+    The month for which the archive serves, formatted according to the
  380
+    ``month_format`` argument.
340 381
 
341  
-    * ``queryset``: A ``QuerySet`` of objects for which the archive serves.
  382
+``queryset``
  383
+    A ``QuerySet`` of objects for which the archive serves.
342 384
 
343  
-    * ``date_field``: The name of the ``DateField`` or ``DateTimeField`` in
344  
-      the ``QuerySet``'s model that the date-based archive should use to
345  
-      determine the objects on the page.
  385
+``date_field``
  386
+    The name of the ``DateField`` or ``DateTimeField`` in the ``QuerySet``'s
  387
+    model that the date-based archive should use to determine the objects on
  388
+    the page.
346 389
 
347  
-**Optional arguments:**
  390
+Optional arguments
  391
+~~~~~~~~~~~~~~~~~~
348 392
 
349  
-    * ``month_format``: A format string that regulates what format the
350  
-      ``month`` parameter uses. This should be in the syntax accepted by
351  
-      Python's ``time.strftime``. (See the `strftime docs`_.) It's set to
352  
-      ``"%b"`` by default, which is a three-letter month abbreviation. To
353  
-      change it to use numbers, use ``"%m"``.
  393
+``month_format``
  394
+    A format string that regulates what format the ``month`` parameter uses.
  395
+    This should be in the syntax accepted by Python's ``time.strftime``. (See
  396
+    the `strftime docs`_.) It's set to ``"%b"`` by default, which is a three-
  397
+    letter month abbreviation. To change it to use numbers, use ``"%m"``.
354 398
 
355  
-    * ``template_name``: The full name of a template to use in rendering the
356  
-      page. This lets you override the default template name (see below).
  399
+``template_name``
  400
+    The full name of a template to use in rendering the page. This lets you
  401
+    override the default template name (see below).
357 402
 
358  
-    * ``template_loader``: The template loader to use when loading the
359  
-      template. By default, it's ``django.template.loader``.
  403
+``template_loader``
  404
+    The template loader to use when loading the template. By default, it's
  405
+    ``django.template.loader``.
360 406
 
361  
-    * ``extra_context``: A dictionary of values to add to the template
362  
-      context. By default, this is an empty dictionary. If a value in the
363  
-      dictionary is callable, the generic view will call it
364  
-      just before rendering the template.
  407
+``extra_context``
  408
+    A dictionary of values to add to the template context. By default, this is
  409
+    an empty dictionary. If a value in the dictionary is callable, the generic
  410
+    view will call it just before rendering the template.
365 411
 
366  
-    * ``allow_empty``: A boolean specifying whether to display the page if no
367  
-      objects are available. If this is ``False`` and no objects are available,
368  
-      the view will raise a 404 instead of displaying an empty page. By
369  
-      default, this is ``False``.
  412
+``allow_empty``
  413
+    A boolean specifying whether to display the page if no objects are
  414
+    available. If this is ``False`` and no objects are available, the view will
  415
+    raise a 404 instead of displaying an empty page. By default, this is
  416
+    ``False``.
370 417
 
371  
-    * ``context_processors``: A list of template-context processors to apply to
372  
-      the view's template. See the `RequestContext docs`_.
  418
+``context_processors``
  419
+    A list of template-context processors to apply to the view's template. See
  420
+    the `RequestContext docs`_.
373 421
 
374  
-    * ``template_object_name``:  Designates the name of the template variable
375  
-      to use in the template context. By default, this is ``'object'``. The
376  
-      view will append ``'_list'`` to the value of this parameter in
377  
-      determining the variable's name.
  422
+``template_object_name``
  423
+    Designates the name of the template variable to use in the template
  424
+    context. By default, this is ``'object'``. The view will append ``'_list'``
  425
+    to the value of this parameter in determining the variable's name.
378 426
 
379  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
380  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  427
+``mimetype``
  428
+    The MIME type to use for the resulting document. Defaults to the value of
  429
+    the ``DEFAULT_CONTENT_TYPE`` setting.
381 430
 
382  
-    * ``allow_future``: A boolean specifying whether to include "future"
383  
-      objects on this page, where "future" means objects in which the field
384  
-      specified in ``date_field`` is greater than the current date/time. By
385  
-      default, this is ``False``.
  431
+``allow_future``
  432
+    A boolean specifying whether to include "future" objects on this page,
  433
+    where "future" means objects in which the field specified in ``date_field``
  434
+    is greater than the current date/time. By default, this is ``False``.
386 435
 
387  
-**Template name:**
  436
+Template name
  437
+~~~~~~~~~~~~~
388 438
 
389 439
 If ``template_name`` isn't specified, this view will use the template
390 440
 ``<app_label>/<model_name>_archive_month.html`` by default.
391 441
 
392  
-**Template context:**
  442
+Template context
  443
+~~~~~~~~~~~~~~~~
393 444
 
394 445
 In addition to ``extra_context``, the template's context will be:
395 446
 
396  
-    * ``month``: A ``datetime.date`` object representing the given month.
  447
+``month``
  448
+    A ``datetime.date`` object representing the given month.
397 449
 
398  
-    * ``next_month``: A ``datetime.date`` object representing the first day of
399  
-      the next month. If the next month is in the future, this will be
400  
-      ``None``.
  450
+``next_month``
  451
+    A ``datetime.date`` object representing the first day of the next month. If
  452
+     the next month is in the future, this will be ``None``.
401 453
 
402  
-    * ``previous_month``: A ``datetime.date`` object representing the first day
403  
-      of the previous month. Unlike ``next_month``, this will never be
404  
-      ``None``.
  454
+``previous_month``
  455
+    A ``datetime.date`` object representing the first day of the previous
  456
+    month. Unlike ``next_month``, this will never be ``None``.
405 457
 
406  
-    * ``object_list``: A list of objects available for the given month. This
407  
-      variable's name depends on the ``template_object_name`` parameter, which
408  
-      is ``'object'`` by default. If ``template_object_name`` is ``'foo'``,
409  
-      this variable's name will be ``foo_list``.
  458
+``object_list``
  459
+    A list of objects available for the given month. This variable's name
  460
+    depends on the ``template_object_name`` parameter, which is ``'object'`` by
  461
+    default. If ``template_object_name`` is ``'foo'``, this variable's name
  462
+    will be ``foo_list``.
410 463
 
411 464
 .. _strftime docs: http://www.python.org/doc/current/lib/module-time.html#l2h-1941
412 465
 
413 466
 ``django.views.generic.date_based.archive_week``
414 467
 ------------------------------------------------
415 468
 
416  
-**Description:**
  469
+Description
  470
+~~~~~~~~~~~
417 471
 
418 472
 A weekly archive page showing all objects in a given week. Objects with a date
419 473
 in the *future* are not displayed unless you set ``allow_future`` to ``True``.
420 474
 
421  
-**Required arguments:**
  475
+Required arguments
  476
+~~~~~~~~~~~~~~~~~~
422 477
 
423  
-    * ``year``: The four-digit year for which the archive serves (a string).
  478
+``year``
  479
+    The four-digit year for which the archive serves (a string).
424 480
 
425  
-    * ``week``: The week of the year for which the archive serves (a string).
426  
-      Weeks start with Sunday.
  481
+``week``
  482
+    The week of the year for which the archive serves (a string). Weeks start
  483
+    with Sunday.
427 484
 
428  
-    * ``queryset``: A ``QuerySet`` of objects for which the archive serves.
  485
+``queryset``
  486
+    A ``QuerySet`` of objects for which the archive serves.
429 487
 
430  
-    * ``date_field``: The name of the ``DateField`` or ``DateTimeField`` in
431  
-      the ``QuerySet``'s model that the date-based archive should use to
432  
-      determine the objects on the page.
  488
+``date_field``
  489
+    The name of the ``DateField`` or ``DateTimeField`` in the ``QuerySet``'s
  490
+    model that the date-based archive should use to determine the objects on
  491
+    the page.
433 492
 
434  
-**Optional arguments:**
  493
+Optional arguments
  494
+~~~~~~~~~~~~~~~~~~
435 495
 
436  
-    * ``template_name``: The full name of a template to use in rendering the
437  
-      page. This lets you override the default template name (see below).
  496
+``template_name``
  497
+    The full name of a template to use in rendering the page. This lets you
  498
+    override the default template name (see below).
438 499
 
439  
-    * ``template_loader``: The template loader to use when loading the
440  
-      template. By default, it's ``django.template.loader``.
  500
+``template_loader``
  501
+    The template loader to use when loading the template. By default, it's
  502
+    ``django.template.loader``.
441 503
 
442  
-    * ``extra_context``: A dictionary of values to add to the template
443  
-      context. By default, this is an empty dictionary. If a value in the
444  
-      dictionary is callable, the generic view will call it
445  
-      just before rendering the template.
  504
+``extra_context``
  505
+    A dictionary of values to add to the template context. By default, this is
  506
+    an empty dictionary. If a value in the dictionary is callable, the generic
  507
+    view will call it just before rendering the template.
446 508
 
447  
-    * ``allow_empty``: A boolean specifying whether to display the page if no
448  
-      objects are available. If this is ``False`` and no objects are available,
449  
-      the view will raise a 404 instead of displaying an empty page. By
450  
-      default, this is ``True``.
  509
+``allow_empty``
  510
+    A boolean specifying whether to display the page if no objects are
  511
+    available. If this is ``False`` and no objects are available, the view will
  512
+    raise a 404 instead of displaying an empty page. By default, this is
  513
+    ``True``.
451 514
 
452  
-    * ``context_processors``: A list of template-context processors to apply to
453  
-      the view's template. See the `RequestContext docs`_.
  515
+``context_processors``
  516
+    A list of template-context processors to apply to the view's template. See
  517
+    the `RequestContext docs`_.
454 518
 
455  
-    * ``template_object_name``:  Designates the name of the template variable
456  
-      to use in the template context. By default, this is ``'object'``. The
457  
-      view will append ``'_list'`` to the value of this parameter in
458  
-      determining the variable's name.
  519
+``template_object_name``
  520
+    Designates the name of the template variable to use in the template
  521
+    context. By default, this is ``'object'``. The view will append ``'_list'``
  522
+    to the value of this parameter in determining the variable's name.
459 523
 
460  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
461  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  524
+``mimetype``
  525
+    The MIME type to use for the resulting document. Defaults to the value of
  526
+    the ``DEFAULT_CONTENT_TYPE`` setting.
462 527
 
463  
-    * ``allow_future``: A boolean specifying whether to include "future"
464  
-      objects on this page, where "future" means objects in which the field
465  
-      specified in ``date_field`` is greater than the current date/time. By
466  
-      default, this is ``False``.
  528
+``allow_future``
  529
+    A boolean specifying whether to include "future" objects on this page,
  530
+    where "future" means objects in which the field specified in ``date_field``
  531
+    is greater than the current date/time. By default, this is ``False``.
467 532
 
468  
-**Template name:**
  533
+Template name
  534
+~~~~~~~~~~~~~
469 535
 
470 536
 If ``template_name`` isn't specified, this view will use the template
471 537
 ``<app_label>/<model_name>_archive_week.html`` by default.
472 538
 
473  
-**Template context:**
  539
+Template context
  540
+~~~~~~~~~~~~~~~~
474 541
 
475 542
 In addition to ``extra_context``, the template's context will be:
476 543
 
477  
-    * ``week``: A ``datetime.date`` object representing the first day of the
478  
-      given week.
  544
+``week``
  545
+    A ``datetime.date`` object representing the first day of the given week.
479 546
 
480  
-    * ``object_list``: A list of objects available for the given week. This
481  
-      variable's name depends on the ``template_object_name`` parameter, which
482  
-      is ``'object'`` by default. If ``template_object_name`` is ``'foo'``,
483  
-      this variable's name will be ``foo_list``.
  547
+``object_list``
  548
+    A list of objects available for the given week. This variable's name
  549
+    depends on the ``template_object_name`` parameter, which is ``'object'`` by
  550
+    default. If ``template_object_name`` is ``'foo'``, this variable's name
  551
+    will be ``foo_list``.
484 552
 
485 553
 ``django.views.generic.date_based.archive_day``
486 554
 -----------------------------------------------
487 555
 
488  
-**Description:**
  556
+Description
  557
+~~~~~~~~~~~
489 558
 
490 559
 A day archive page showing all objects in a given day. Days in the future throw
491 560
 a 404 error, regardless of whether any objects exist for future days, unless
492 561
 you set ``allow_future`` to ``True``.
493 562
 
494  
-**Required arguments:**
  563
+Required arguments
  564
+~~~~~~~~~~~~~~~~~~
495 565
 
496  
-    * ``year``: The four-digit year for which the archive serves (a string).
  566
+``year``
  567
+    The four-digit year for which the archive serves (a string).
497 568
 
498  
-    * ``month``: The month for which the archive serves, formatted according to
499  
-      the ``month_format`` argument.
  569
+``month``
  570
+    The month for which the archive serves, formatted according to the
  571
+    ``month_format`` argument.
500 572
 
501  
-    * ``day``: The day for which the archive serves, formatted according to the
502  
-      ``day_format`` argument.
  573
+``day``
  574
+    The day for which the archive serves, formatted according to the
  575
+    ``day_format`` argument.
503 576
 
504  
-    * ``queryset``: A ``QuerySet`` of objects for which the archive serves.
  577
+``queryset``
  578
+    A ``QuerySet`` of objects for which the archive serves.
505 579
 
506  
-    * ``date_field``: The name of the ``DateField`` or ``DateTimeField`` in
507  
-      the ``QuerySet``'s model that the date-based archive should use to
508  
-      determine the objects on the page.
  580
+``date_field``
  581
+    The name of the ``DateField`` or ``DateTimeField`` in the ``QuerySet``'s
  582
+    model that the date-based archive should use to determine the objects on
  583
+    the page.
509 584
 
510  
-**Optional arguments:**
  585
+Optional arguments
  586
+~~~~~~~~~~~~~~~~~~
511 587
 
512  
-    * ``month_format``: A format string that regulates what format the
513  
-      ``month`` parameter uses. This should be in the syntax accepted by
514  
-      Python's ``time.strftime``. (See the `strftime docs`_.) It's set to
515  
-      ``"%b"`` by default, which is a three-letter month abbreviation. To
516  
-      change it to use numbers, use ``"%m"``.
  588
+``month_format``
  589
+    A format string that regulates what format the ``month`` parameter uses.
  590
+    This should be in the syntax accepted by Python's ``time.strftime``. (See
  591
+    the `strftime docs`_.) It's set to ``"%b"`` by default, which is a three-
  592
+    letter month abbreviation. To change it to use numbers, use ``"%m"``.
517 593
 
518  
-    * ``day_format``: Like ``month_format``, but for the ``day`` parameter.
519  
-      It defaults to ``"%d"`` (day of the month as a decimal number, 01-31).
  594
+``day_format``
  595
+    Like ``month_format``, but for the ``day`` parameter. It defaults to
  596
+    ``"%d"`` (day of the month as a decimal number, 01-31).
520 597
 
521  
-    * ``template_name``: The full name of a template to use in rendering the
522  
-      page. This lets you override the default template name (see below).
  598
+``template_name``
  599
+    The full name of a template to use in rendering the page. This lets you
  600
+    override the default template name (see below).
523 601
 
524  
-    * ``template_loader``: The template loader to use when loading the
525  
-      template. By default, it's ``django.template.loader``.
  602
+``template_loader``
  603
+    The template loader to use when loading the template. By default, it's
  604
+    ``django.template.loader``.
526 605
 
527  
-    * ``extra_context``: A dictionary of values to add to the template
528  
-      context. By default, this is an empty dictionary. If a value in the
529  
-      dictionary is callable, the generic view will call it
530  
-      just before rendering the template.
  606
+``extra_context``
  607
+    A dictionary of values to add to the template context. By default, this is
  608
+    an empty dictionary. If a value in the dictionary is callable, the generic
  609
+    view will call it just before rendering the template.
531 610
 
532  
-    * ``allow_empty``: A boolean specifying whether to display the page if no
533  
-      objects are available. If this is ``False`` and no objects are available,
534  
-      the view will raise a 404 instead of displaying an empty page. By
535  
-      default, this is ``False``.
  611
+``allow_empty``
  612
+    A boolean specifying whether to display the page if no objects are
  613
+    available. If this is ``False`` and no objects are available, the view will
  614
+    raise a 404 instead of displaying an empty page. By default, this is
  615
+    ``False``.
536 616
 
537  
-    * ``context_processors``: A list of template-context processors to apply to
538  
-      the view's template. See the `RequestContext docs`_.
  617
+``context_processors``
  618
+    A list of template-context processors to apply to the view's template. See
  619
+    the `RequestContext docs`_.
539 620
 
540  
-    * ``template_object_name``:  Designates the name of the template variable
541  
-      to use in the template context. By default, this is ``'object'``. The
542  
-      view will append ``'_list'`` to the value of this parameter in
543  
-      determining the variable's name.
  621
+``template_object_name``
  622
+     Designates the name of the template variable to use in the template
  623
+     context. By default, this is ``'object'``. The view will append
  624
+     ``'_list'`` to the value of this parameter in determining the variable's
  625
+     name.
544 626
 
545  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
546  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  627
+``mimetype``
  628
+    The MIME type to use for the resulting document. Defaults to the value of
  629
+    the ``DEFAULT_CONTENT_TYPE`` setting.
547 630
 
548  
-    * ``allow_future``: A boolean specifying whether to include "future"
549  
-      objects on this page, where "future" means objects in which the field
550  
-      specified in ``date_field`` is greater than the current date/time. By
551  
-      default, this is ``False``.
  631
+``allow_future``
  632
+    A boolean specifying whether to include "future" objects on this page,
  633
+    where "future" means objects in which the field specified in ``date_field``
  634
+    is greater than the current date/time. By default, this is ``False``.
552 635
 
553  
-**Template name:**
  636
+Template name
  637
+~~~~~~~~~~~~~
554 638
 
555 639
 If ``template_name`` isn't specified, this view will use the template
556 640
 ``<app_label>/<model_name>_archive_day.html`` by default.
557 641
 
558  
-**Template context:**
  642
+Template context
  643
+~~~~~~~~~~~~~~~~
559 644
 
560 645
 In addition to ``extra_context``, the template's context will be:
561 646
 
562  
-    * ``day``: A ``datetime.date`` object representing the given day.
  647
+``day``
  648
+    A ``datetime.date`` object representing the given day.
563 649
 
564  
-    * ``next_day``: A ``datetime.date`` object representing the next day. If
565  
-      the next day is in the future, this will be ``None``.
  650
+``next_day``
  651
+    A ``datetime.date`` object representing the next day. If the next day is in
  652
+    the future, this will be ``None``.
566 653
 
567  
-    * ``previous_day``: A ``datetime.date`` object representing the given day.
568  
-      Unlike ``next_day``, this will never be ``None``.
  654
+``previous_day``
  655
+    A ``datetime.date`` object representing the given day. Unlike ``next_day``,
  656
+    this will never be ``None``.
569 657
 
570  
-    * ``object_list``: A list of objects available for the given day. This
571  
-      variable's name depends on the ``template_object_name`` parameter, which
572  
-      is ``'object'`` by default. If ``template_object_name`` is ``'foo'``,
573  
-      this variable's name will be ``foo_list``.
  658
+``object_list``
  659
+    A list of objects available for the given day. This variable's name depends
  660
+    on the ``template_object_name`` parameter, which is ``'object'`` by
  661
+    default. If ``template_object_name`` is ``'foo'``, this variable's name
  662
+    will be ``foo_list``.
574 663
 
575 664
 ``django.views.generic.date_based.archive_today``
576 665
 -------------------------------------------------
577 666
 
578  
-**Description:**
  667
+Description
  668
+~~~~~~~~~~~
579 669
 
580 670
 A day archive page showing all objects for *today*. This is exactly the same as
581 671
 ``archive_day``, except the ``year``/``month``/``day`` arguments are not used,
@@ -584,95 +674,108 @@ and today's date is used instead.
584 674
 ``django.views.generic.date_based.object_detail``
585 675
 -------------------------------------------------
586 676
 
587  
-**Description:**
  677
+Description
  678
+~~~~~~~~~~~
588 679
 
589 680
 A page representing an individual object. If the object has a date value in the
590 681
 future, the view will throw a 404 error by default, unless you set
591 682
 ``allow_future`` to ``True``.
592 683
 
593  
-**Required arguments:**
594  
-
595  
-    * ``year``: The object's four-digit year (a string).
  684
+Required arguments
  685
+~~~~~~~~~~~~~~~~~~
596 686
 
597  
-    * ``month``: The object's month , formatted according to the
598  
-      ``month_format`` argument.
  687
+``year``
  688
+    The object's four-digit year (a string).
599 689
 
600  
-    * ``day``: The object's day , formatted according to the ``day_format``
601  
-      argument.
  690
+``month``
  691
+    The object's month , formatted according to the ``month_format`` argument.
602 692
 
603  
-    * ``queryset``: A ``QuerySet`` that contains the object.
  693
+``day``
  694
+    The object's day , formatted according to the ``day_format`` argument.
604 695
 
605  
-    * ``date_field``: The name of the ``DateField`` or ``DateTimeField`` in
606  
-      the ``QuerySet``'s model that the generic view should use to look up the
607  
-      object according to ``year``, ``month`` and ``day``.
  696
+``queryset``
  697
+    A ``QuerySet`` that contains the object.
608 698
 
609  
-    * Either ``object_id`` or (``slug`` *and* ``slug_field``) is required.
  699
+``date_field``
  700
+    The name of the ``DateField`` or ``DateTimeField`` in the ``QuerySet``'s
  701
+    model that the generic view should use to look up the object according to
  702
+    ``year``, ``month`` and ``day``.
610 703
 
611  
-      If you provide ``object_id``, it should be the value of the primary-key
612  
-      field for the object being displayed on this page.
  704
+Either ``object_id`` or (``slug`` *and* ``slug_field``) is required.
  705
+    If you provide ``object_id``, it should be the value of the primary-key
  706
+    field for the object being displayed on this page.
613 707
 
614  
-      Otherwise, ``slug`` should be the slug of the given object, and
615  
-      ``slug_field`` should be the name of the slug field in the ``QuerySet``'s
616  
-      model. By default, ``slug_field`` is ``'slug'``.
  708
+    Otherwise, ``slug`` should be the slug of the given object, and
  709
+    ``slug_field`` should be the name of the slug field in the ``QuerySet``'s
  710
+    model. By default, ``slug_field`` is ``'slug'``.
617 711
 
618  
-**Optional arguments:**
  712
+Optional arguments
  713
+~~~~~~~~~~~~~~~~~~
619 714
 
620  
-    * ``month_format``: A format string that regulates what format the
621  
-      ``month`` parameter uses. This should be in the syntax accepted by
622  
-      Python's ``time.strftime``. (See the `strftime docs`_.) It's set to
623  
-      ``"%b"`` by default, which is a three-letter month abbreviation. To
624  
-      change it to use numbers, use ``"%m"``.
  715
+``month_format``
  716
+    A format string that regulates what format the ``month`` parameter uses.
  717
+    This should be in the syntax accepted by Python's ``time.strftime``. (See
  718
+    the `strftime docs`_.) It's set to ``"%b"`` by default, which is a three-
  719
+    letter month abbreviation. To change it to use numbers, use ``"%m"``.
625 720
 
626  
-    * ``day_format``: Like ``month_format``, but for the ``day`` parameter.
627  
-      It defaults to ``"%d"`` (day of the month as a decimal number, 01-31).
  721
+``day_format``
  722
+    Like ``month_format``, but for the ``day`` parameter. It defaults to
  723
+    ``"%d"`` (day of the month as a decimal number, 01-31).
628 724
 
629  
-    * ``template_name``: The full name of a template to use in rendering the
630  
-      page. This lets you override the default template name (see below).
  725
+``template_name``
  726
+    The full name of a template to use in rendering the page. This lets you
  727
+    override the default template name (see below).
631 728
 
632  
-    * ``template_name_field``: The name of a field on the object whose value is
633  
-      the template name to use. This lets you store template names in the data.
634  
-      In other words, if your object has a field ``'the_template'`` that
635  
-      contains a string ``'foo.html'``, and you set ``template_name_field`` to
636  
-      ``'the_template'``, then the generic view for this object will use the
637  
-      template ``'foo.html'``.
  729
+``template_name_field``
  730
+    The name of a field on the object whose value is the template name to use.
  731
+    This lets you store template names in the data. In other words, if your
  732
+    object has a field ``'the_template'`` that contains a string
  733
+    ``'foo.html'``, and you set ``template_name_field`` to ``'the_template'``,
  734
+    then the generic view for this object will use the template ``'foo.html'``.
638 735
 
639  
-      It's a bit of a brain-bender, but it's useful in some cases.
  736
+    It's a bit of a brain-bender, but it's useful in some cases.
640 737
 
641  
-    * ``template_loader``: The template loader to use when loading the
642  
-      template. By default, it's ``django.template.loader``.
  738
+``template_loader``
  739
+    The template loader to use when loading the  template. By default, it's
  740
+    ``django.template.loader``.
643 741
 
644  
-    * ``extra_context``: A dictionary of values to add to the template
645  
-      context. By default, this is an empty dictionary. If a value in the
646  
-      dictionary is callable, the generic view will call it
647  
-      just before rendering the template.
  742
+``extra_context``
  743
+    A dictionary of values to add to the template context. By default, this is
  744
+    an empty dictionary. If a value in the dictionary is callable, the generic
  745
+    view will call it just before rendering the template.
648 746
 
649  
-    * ``context_processors``: A list of template-context processors to apply to
650  
-      the view's template. See the `RequestContext docs`_.
  747
+``context_processors``
  748
+    A list of template-context processors to apply to the view's template. See
  749
+    the `RequestContext docs`_.
651 750
 
652  
-    * ``template_object_name``:  Designates the name of the template variable
653  
-      to use in the template context. By default, this is ``'object'``.
  751
+``template_object_name``
  752
+    Designates the name of the template variable to use in the template
  753
+    context. By default, this is ``'object'``.
654 754
 
655  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
656  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  755
+``mimetype``
  756
+    The MIME type to use for the resulting document. Defaults to the value of
  757
+    the ``DEFAULT_CONTENT_TYPE`` setting.
657 758
 
658  
-    * ``allow_future``: A boolean specifying whether to include "future"
659  
-      objects on this page, where "future" means objects in which the field
660  
-      specified in ``date_field`` is greater than the current date/time. By
661  
-      default, this is ``False``.
  759
+``allow_future``
  760
+    A boolean specifying whether to include "future" objects on this page,
  761
+    where "future" means objects in which the field specified in ``date_field``
  762
+    is greater than the current date/time. By default, this is ``False``.
662 763
 
663  
-**Template name:**
  764
+Template name
  765
+~~~~~~~~~~~~~
664 766
 
665 767
 If ``template_name`` isn't specified, this view will use the template
666 768
 ``<app_label>/<model_name>_detail.html`` by default.
667 769
 
668  
-**Template context:**
  770
+Template context
  771
+~~~~~~~~~~~~~~~~
669 772
 
670 773
 In addition to ``extra_context``, the template's context will be:
671 774
 
672  
-    * ``object``: The object. This variable's name depends on the
673  
-      ``template_object_name`` parameter, which is ``'object'`` by default. If
674  
-      ``template_object_name`` is ``'foo'``, this variable's name will be
675  
-      ``foo``.
  775
+``object``
  776
+    The object. This variable's name depends on the ``template_object_name``
  777
+    parameter, which is ``'object'`` by default. If ``template_object_name`` is
  778
+    ``'foo'``, this variable's name will be ``foo``.
676 779
 
677 780
 List/detail generic views
678 781
 =========================
@@ -685,77 +788,92 @@ object page.
685 788
 ``django.views.generic.list_detail.object_list``
686 789
 ------------------------------------------------
687 790
 
688  
-**Description:**
  791
+Description
  792
+~~~~~~~~~~~
689 793
 
690 794
 A page representing a list of objects.
691 795
 
692  
-**Required arguments:**
  796
+Required arguments
  797
+~~~~~~~~~~~~~~~~~~
693 798
 
694  
-    * ``queryset``: A ``QuerySet`` that represents the objects.
  799
+``queryset``
  800
+    A ``QuerySet`` that represents the objects.
695 801
 
696  
-**Optional arguments:**
  802
+Optional arguments
  803
+~~~~~~~~~~~~~~~~~~
697 804
 
698  
-    * ``paginate_by``: An integer specifying how many objects should be
699  
-      displayed per page. If this is given, the view will paginate objects with
700  
-      ``paginate_by`` objects per page. The view will expect either a ``page``
701  
-      query string parameter (via ``GET``) or a ``page`` variable specified in
702  
-      the URLconf. See `Notes on pagination`_ below.
  805
+``paginate_by``
  806
+    An integer specifying how many objects should be displayed per page. If
  807
+    this is given, the view will paginate objects with ``paginate_by`` objects
  808
+    per page. The view will expect either a ``page`` query string parameter
  809
+    (via ``GET``) or a ``page`` variable specified in the URLconf. See `Notes
  810
+    on pagination`_ below.
703 811
 
704  
-    * ``page``: The current (1-based) page number, as an integer, or the string
705  
-      ``'last'``. See `Notes on pagination`_ below.
  812
+``page``
  813
+    The current (1-based) page number, as an integer, or the string ``'last'``.
  814
+    See `Notes on pagination`_ below.
706 815
 
707  
-    * ``template_name``: The full name of a template to use in rendering the
708  
-      page. This lets you override the default template name (see below).
  816
+``template_name``
  817
+    The full name of a template to use in rendering the page. This lets you
  818
+    override the default template name (see below).
709 819
 
710  
-    * ``template_loader``: The template loader to use when loading the
711  
-      template. By default, it's ``django.template.loader``.
  820
+``template_loader``
  821
+    The template loader to use when loading the template. By default, it's
  822
+    ``django.template.loader``.
712 823
 
713  
-    * ``extra_context``: A dictionary of values to add to the template
714  
-      context. By default, this is an empty dictionary. If a value in the
715  
-      dictionary is callable, the generic view will call it
716  
-      just before rendering the template.
  824
+``extra_context``
  825
+    A dictionary of values to add to the template context. By default, this is
  826
+    an empty dictionary. If a value in the dictionary is callable, the generic
  827
+    view will call it just before rendering the template.
717 828
 
718  
-    * ``allow_empty``: A boolean specifying whether to display the page if no
719  
-      objects are available. If this is ``False`` and no objects are available,
720  
-      the view will raise a 404 instead of displaying an empty page. By
721  
-      default, this is ``True``.
  829
+``allow_empty``
  830
+    A boolean specifying whether to display the page if no objects are
  831
+    available. If this is ``False`` and no objects are available, the view will
  832
+    raise a 404 instead of displaying an empty page. By default, this is
  833
+    ``True``.
722 834
 
723  
-    * ``context_processors``: A list of template-context processors to apply to
724  
-      the view's template. See the `RequestContext docs`_.
  835
+``context_processors``
  836
+    A list of template-context processors to apply to the view's template. See
  837
+    the `RequestContext docs`_.
725 838
 
726  
-    * ``template_object_name``:  Designates the name of the template variable
727  
-      to use in the template context. By default, this is ``'object'``. The
728  
-      view will append ``'_list'`` to the value of this parameter in
729  
-      determining the variable's name.
  839
+``template_object_name``
  840
+    Designates the name of the template variable to use in the template
  841
+    context. By default, this is ``'object'``. The view will append ``'_list'``
  842
+    to the value of this parameter in determining the variable's name.
730 843
 
731  
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
732  
-      to the value of the ``DEFAULT_CONTENT_TYPE`` setting.
  844
+``mimetype``
  845
+    The MIME type to use for the resulting document. Defaults to the value of
  846
+    the ``DEFAULT_CONTENT_TYPE`` setting.
733 847
 
734  
-**Template name:**
  848
+Template name
  849
+~~~~~~~~~~~~~
735 850
 
736 851
 If ``template_name`` isn't specified, this view will use the template
737 852
 ``<app_label>/<model_name>_list.html`` by default.
738 853
 
739  
-**Template context:**
  854
+Template context
  855
+~~~~~~~~~~~~~~~~
740 856
 
741 857
 In addition to ``extra_context``, the template's context will be:
742 858
 
743  
-    * ``object_list``: The list of objects. This variable's name depends on the
744  
-      ``template_object_name`` parameter, which is ``'object'`` by default. If
745  
-      ``template_object_name`` is ``'foo'``, this variable's name will be
746  
-      ``foo_list``.
  859
+``object_list``
  860
+    The list of objects. This variable's name depends on the
  861
+    ``template_object_name`` parameter, which is ``'object'`` by default. If
  862
+    ``template_object_name`` is ``'foo'``, this variable's name will be
  863
+    ``foo_list``.
747 864
 
748  
-    * ``is_paginated``: A boolean representing whether the results are
749  
-      paginated. Specifically, this is set to ``False`` if the number of
750  
-      available objects is less than or equal to ``paginate_by``.
  865
+``is_paginated``
  866
+    A boolean representing whether the results are paginated. Specifically,