summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Holovaty <adrian@holovaty.com>2005-11-16 00:25:48 +0000
committerAdrian Holovaty <adrian@holovaty.com>2005-11-16 00:25:48 +0000
commit2d49f70b0d2fb566ffbc3d7bc78b057c6f84b13f (patch)
tree912ef0d892c67545267e3f140e0e0e7b433fa19f
parent991039dd1e1f89dc1d20c35cdd216abb110a3bee (diff)
downloaddjango-2d49f70b0d2fb566ffbc3d7bc78b057c6f84b13f.tar.gz
Small style cleanup of docs/generic_views.txt
git-svn-id: http://code.djangoproject.com/svn/django/trunk@1256 bcc190cf-cafb-0310-a4f2-bffc1f526a37
-rw-r--r--docs/generic_views.txt23
1 files changed, 12 insertions, 11 deletions
diff --git a/docs/generic_views.txt b/docs/generic_views.txt
index 9db1577d71..16a3c2d5bc 100644
--- a/docs/generic_views.txt
+++ b/docs/generic_views.txt
@@ -76,33 +76,34 @@ couple of common cases: rendering a template when no view logic is needed,
and issuing a redirect. These views are:
``direct_to_template``
- Renders a given template using any extra parameters passed in the
- urlpattern; requires the ``template`` argument.
-
+ Renders a given template, passing it a ``{{ params }}`` template variable,
+ which is a dictionary of the parameters captured in the URL. This requires
+ the ``template`` argument.
+
For example, given the following URL patterns::
-
+
urlpatterns = patterns('django.views.generic.simple',
- (r'^foo/$', 'direct_to_template', {'template' : 'foo_index'}),
- (r'^foo/(?P<id>\d+)/$', 'direct_to_template', {'template' : 'foo_detail'}),
+ (r'^foo/$', 'direct_to_template', {'template': 'foo_index'}),
+ (r'^foo/(?P<id>\d+)/$', 'direct_to_template', {'template': 'foo_detail'}),
)
-
+
... a request to ``/foo/`` would cause the ``foo_index`` template to be
rendered, and a request to ``/foo/15/`` would cause the ``foo_detail``
template to be rendered with a context variable ``{{ params.id }}`` that is
set to ``15``.
-
+
``redirect_to``
Issue a redirect to a given URL.
- The given url may contain dict-style string formatting which will be
+ The given URL may contain dict-style string formatting, which will be
interpolated against the params in the URL. For example, to redirect from
``/foo/<id>/`` to ``/bar/<id>/``, you could use the following urlpattern::
urlpatterns = patterns('django.views.generic.simple',
('^foo/(?p<id>\d+)/$', 'redirect_to', {'url' : '/bar/%(id)s/'}),
)
-
- If the given url is ``None``, a HttpResponseGone (410) will be issued.
+
+ If the given URL is ``None``, an ``HttpResponseGone`` (410) will be issued.
Using date-based generic views
==============================