diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/wsgi.rst | 1 | ||||
| -rw-r--r-- | docs/glossary.rst | 5 | ||||
| -rw-r--r-- | docs/narr/traversal.rst | 16 |
3 files changed, 22 insertions, 0 deletions
diff --git a/docs/api/wsgi.rst b/docs/api/wsgi.rst index 15bde75ed..6b5423c55 100644 --- a/docs/api/wsgi.rst +++ b/docs/api/wsgi.rst @@ -7,3 +7,4 @@ .. autofunction:: wsgiapp + .. autofunction:: wsgiapp2 diff --git a/docs/glossary.rst b/docs/glossary.rst index a0484bc65..5427a7602 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -339,3 +339,8 @@ Glossary alternative mechanisms for common :mod:`repoze.bfg` application configuration tasks. The functionality of this package has been merged into the :mod:`repoze.bfg` core as of version 0.6.3. + Virtual root + A model object representing the "virtual" root of a request; this + is typically the physical root object (the object returned by the + application root factory) unless :ref:`vhosting_chapter` is in + use. diff --git a/docs/narr/traversal.rst b/docs/narr/traversal.rst index 9ff7329c5..3977f46d0 100644 --- a/docs/narr/traversal.rst +++ b/docs/narr/traversal.rst @@ -282,6 +282,22 @@ The :term:`context` will always be available to a view as the ``context`` attribute of the :term:`request` object. It will be the context object implied by the current request. +The "traversal path" will always be available to a view as the +``traversed`` attribute of the :term:`request` object. It will be a +sequence representing the ordered set of names that were used to +traverse to the context, not including the view name or subpath. If +there is a virtual root associated with request, the virtual root path +is included within the traversal path. + +The :term:`virtual root` will always be available to a view as the +``virtual_root`` attribute of the :term:`request` object. It will be +the virtual root object implied by the current request. + +The :term:`virtual root path` will always be available to a view as +the ``virtual_root_path`` attribute of the :term:`request` object. It +will be a sequence representing the ordered set of names that were +used to traverse to the virtual root obejct. + Unicode and Traversal --------------------- |