Skip to content

Commit

Permalink
Merge branch '1.3-branch'
Browse files Browse the repository at this point in the history
  • Loading branch information
mcdonc committed Mar 21, 2012
2 parents 731d5f5 + eb33944 commit 036a633
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 20 deletions.
4 changes: 2 additions & 2 deletions CHANGES.txt
@@ -1,5 +1,5 @@
Next release
============
1.3 (2012-03-21)
================

Bug Fixes
---------
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -80,7 +80,7 @@ def nothing(*arg):
# other places throughout the built documents.
#
# The short X.Y version.
version = '1.3b3'
version = '1.3'

# The full version, including alpha/beta/rc tags.
release = version
Expand Down
49 changes: 33 additions & 16 deletions docs/narr/templates.rst
Expand Up @@ -253,34 +253,51 @@ 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,
e.g. ``mypackage:templates/foo.pt``.

``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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -64,7 +64,7 @@
testing_extras = tests_require + ['nose', 'coverage']

setup(name='pyramid',
version='1.3b3',
version='1.3',
description=('The Pyramid web application development framework, a '
'Pylons project'),
long_description=README + '\n\n' + CHANGES,
Expand Down

0 comments on commit 036a633

Please sign in to comment.