summaryrefslogtreecommitdiff
path: root/docs/narr/templates.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2012-03-21 18:58:22 -0400
committerChris McDonough <chrism@plope.com>2012-03-21 18:58:22 -0400
commiteb33944d0d861bbb3aebdf069cce64f8c1c3faef (patch)
tree19d19b946405e6add8cd7886190948978e42f5a4 /docs/narr/templates.rst
parent7c88fec67a3c3edd33ef44dc0ad0c55fb672b7e1 (diff)
downloadpyramid-eb33944d0d861bbb3aebdf069cce64f8c1c3faef.tar.gz
pyramid-eb33944d0d861bbb3aebdf069cce64f8c1c3faef.tar.bz2
pyramid-eb33944d0d861bbb3aebdf069cce64f8c1c3faef.zip
flesh out system values
Diffstat (limited to 'docs/narr/templates.rst')
-rw-r--r--docs/narr/templates.rst49
1 files changed, 33 insertions, 16 deletions
diff --git a/docs/narr/templates.rst b/docs/narr/templates.rst
index ed700f7b4..9db0b1c4d 100644
--- a/docs/narr/templates.rst
+++ b/docs/narr/templates.rst
@@ -253,16 +253,26 @@ System Values Used During Rendering
When a template is rendered using
:func:`~pyramid.renderers.render_to_response` or
-:func:`~pyramid.renderers.render`, the renderer representing the
-template will be provided with a number of *system* values. These
-values are provided in a dictionary to the renderer and include:
-
-``context``
- The current :app:`Pyramid` context if ``request`` was provided as
- a keyword argument, or ``None``.
+:func:`~pyramid.renderers.render`, or a ``renderer=`` argument to view
+configuration (see :ref:`templates_used_as_renderers`), the renderer
+representing the template will be provided with a number of *system* values.
+These values are provided to the template:
``request``
- The request provided as a keyword argument.
+ The value provided as the ``request`` keyword argument to
+ ``render_to_response`` or ``render`` *or* the request object passed to the
+ view when the ``renderer=`` argument to view configuration is being used to
+ render the template.
+
+``req``
+ An alias for ``request``.
+
+``context``
+ The current :app:`Pyramid` :term:`context` if ``request`` was provided as a
+ keyword argument to ``render_to_response`` or ``render``, or ``None`` if
+ the ``request`` keyword argument was not provided. This value will always
+ be provided if the template is rendered as the result of a ``renderer=``
+ argument to view configuration being used.
``renderer_name``
The renderer name used to perform the rendering,
@@ -270,17 +280,24 @@ values are provided in a dictionary to the renderer and include:
``renderer_info``
An object implementing the :class:`pyramid.interfaces.IRendererInfo`
- interface. Basically, an object with the following attributes:
- ``name``, ``package`` and ``type``.
+ interface. Basically, an object with the following attributes: ``name``,
+ ``package`` and ``type``.
+
+``view``
+ The view callable object that was used to render this template. If the
+ view callable is a method of a class-based view, this will be an instance
+ of the class that the method was defined on. If the view callable is a
+ function or instance, it will be that function or instance. Note that this
+ value will only be automatically present when a template is rendered as a
+ result of a ``renderer=`` argument; it will be ``None`` when the
+ ``render_to_response`` or ``render`` APIs are used.
-You can define more values which will be passed to every template
-executed as a result of rendering by defining :term:`renderer
-globals`.
+You can define more values which will be passed to every template executed as
+a result of rendering by defining :term:`renderer globals`.
What any particular renderer does with these system values is up to the
-renderer itself, but most template renderers, including Chameleon and
-Mako renderers, make these names available as top-level template
-variables.
+renderer itself, but most template renderers, including Chameleon and Mako
+renderers, make these names available as top-level template variables.
.. index::
pair: renderer; templates