diff options
Diffstat (limited to 'docs/glossary.rst')
| -rw-r--r-- | docs/glossary.rst | 114 |
1 files changed, 63 insertions, 51 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index 49d273197..3c6f5cb1a 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -89,9 +89,9 @@ Glossary dotted Python name A reference to a Python object by name using a string, in the form ``path.to.modulename:attributename``. Often used in Paste and - setuptools configurations. A variant is used in dotted names - within :term:`ZCML` attributes that name objects (such as the ZCML - "view" directive's "view" attribute): the colon (``:``) is not + setuptools configurations. A variant is used in dotted names within + configurator method arguments that name objects (such as the "add_view" + method's "view" and "context" attributes): the colon (``:``) is not used; in its place is a dot. view @@ -112,14 +112,14 @@ Glossary about :app:`Pyramid` view callables. view configuration - View configuration is the act of associating a :term:`view - callable` with configuration information. This configuration - information helps map a given :term:`request` to a particular view - callable and it can influence the response of a view callable. - :app:`Pyramid` views can be configured via :term:`imperative - configuration`, :term:`ZCML` or by a special ``@view_config`` - decorator coupled with a :term:`scan`. See :ref:`views_chapter` - for more information about view configuration. + View configuration is the act of associating a :term:`view callable` + with configuration information. This configuration information helps + map a given :term:`request` to a particular view callable and it can + influence the response of a view callable. :app:`Pyramid` views can be + configured via :term:`imperative configuration`, or by a special + ``@view_config`` decorator coupled with a :term:`scan`. See + :ref:`view_config_chapter` for more information about view + configuration. view name The "URL name" of a view, e.g ``index.html``. If a view is @@ -285,7 +285,7 @@ Glossary WSGI `Web Server Gateway Interface <http://wsgi.org/>`_. This is a Python standard for connecting web applications to web servers, - similar to the concept of Java Servlets. ``pyramid`` requires + similar to the concept of Java Servlets. :app:`Pyramid` requires that your application be served as a WSGI application. middleware @@ -377,29 +377,10 @@ Glossary ultimately a :term:`view`). See also :term:`url dispatch`. route configuration - Route configuration is the act of using :term:`imperative - configuration` or a :term:`ZCML` ``<route>`` statement to - associate request parameters with a particular :term:`route` using - pattern matching and :term:`route predicate` statements. See - :ref:`urldispatch_chapter` for more information about route - configuration. - - ZCML - `Zope Configuration Markup Language - <http://www.muthukadan.net/docs/zca.html#zcml>`_, an XML dialect - used by Zope and :app:`Pyramid` for configuration tasks. ZCML - is capable of performing different types of :term:`configuration - declaration`, but its primary purpose in :app:`Pyramid` is to - perform :term:`view configuration` and :term:`route configuration` - within the ``configure.zcml`` file in a :app:`Pyramid` - application. You can use ZCML as an alternative to - :term:`imperative configuration`. - - ZCML directive - A ZCML "tag" such as ``<view>`` or ``<route>``. - - ZCML declaration - The concrete use of a :term:`ZCML directive` within a ZCML file. + Route configuration is the act of associating request parameters with a + particular :term:`route` using pattern matching and :term:`route + predicate` statements. See :ref:`urldispatch_chapter` for more + information about route configuration. Zope Component Architecture The `Zope Component Architecture @@ -457,9 +438,9 @@ Glossary subscriber A callable which receives an :term:`event`. A callable becomes a - subscriber via :term:`imperative configuration` or the - ``<subscriber>`` ZCML directive. See :ref:`events_chapter` for - more information. + subscriber via :term:`imperative configuration` or via + :term:`configuration decoration`. See :ref:`events_chapter` for more + information. request type An attribute of a :term:`request` that allows for specialization @@ -577,15 +558,13 @@ Glossary also `PEP 318 <http://www.python.org/dev/peps/pep-0318/>`_. configuration declaration - An individual method call made to an instance of a - :app:`Pyramid` :term:`Configurator` object which performs an - arbitrary action, such as registering a :term:`view configuration` - (via the ``view`` method of the configurator) or :term:`route - configuration` (via the ``route`` method of the configurator). A - set of configuration declarations is also usually implied via the - use of a :term:`ZCML declaration` within an application, or a set - of configuration declarations might be performed by a :term:`scan` - of code in a package. + An individual method call made to an instance of a :app:`Pyramid` + :term:`Configurator` object which performs an arbitrary action, such as + registering a :term:`view configuration` (via the ``add_view`` method of + the configurator) or :term:`route configuration` (via the ``add_route`` + method of the configurator). A set of configuration declarations is + also implied by the :term:`configuration decoration` detected by a + :term:`scan` of code in a package. configuration decoration Metadata implying one or more :term:`configuration declaration` @@ -609,8 +588,8 @@ Glossary declaration` required by your application. declarative configuration - The configuration mode in which you use :term:`ZCML` to make - a set of :term:`configuration declaration` statements. + The configuration mode in which you use :term:`ZCML` to make a set of + :term:`configuration declaration` statements. See :term:`pyramid_zcml`. Not Found view An :term:`exception view` invoked by :app:`Pyramid` when the @@ -834,7 +813,7 @@ Glossary :meth:`pyramid.config.Configurator.add_route` and :meth:`pyramid.config.Configurator.add_view` to make it more convenient to register a collection of views as a single class when - using :term:`url dispatch`. See also :ref:`handlers_chapter`. + using :term:`url dispatch`. See also :ref:`views_chapter`. Deployment settings Deployment settings are settings passed to the :term:`Configurator` as a @@ -850,6 +829,39 @@ Glossary WSGI middleware which can display debuggable traceback information in the browser when an exception is raised by a Pyramid application. See http://pypi.python.org/pypi/WebError . - + view mapper + A view mapper is a class which implements the + :class:`pyramid.interfaces.IViewMapperFactory` interface, which performs + view argument and return value mapping. This is a plug point for + extension builders, not normally used by "civilians". + + matchdict + The dictionary attached to the :term:`request` object as + ``request.matchdict`` when a :term:`URL dispatch` route has been matched. + Its keys are names as identified within the route pattern; its values are + the values matched by each pattern name. + + pyramid_zcml + An add-on package to :app:`Pyramid` which allows applications to be + configured via ZCML. It is available on :term:`PyPI`. If you use + ``pyramid_zcml``, you can use ZCML as an alternative to + :term:`imperative configuration`. + + ZCML + `Zope Configuration Markup Language + <http://www.muthukadan.net/docs/zca.html#zcml>`_, an XML dialect + used by Zope and :term:`pyramid_zcml` for configuration tasks. + + ZCML directive + A ZCML "tag" such as ``<view>`` or ``<route>``. + + ZCML declaration + The concrete use of a :term:`ZCML directive` within a ZCML file. + + pyramid_handlers + An add-on package which allows :app:`Pyramid` users to create classes + that are analogues of Pylons 1 "controllers". See + `http://docs.pylonsproject.org/projects/pyramid_handlers/dev/ + <http://docs.pylonsproject.org/projects/pyramid_handlers/dev/>`_. |