summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2010-10-25 18:13:44 -0400
committerChris McDonough <chrism@plope.com>2010-10-25 18:13:44 -0400
commitc03dbcca24aeedfb688bf49b7ccfeef20f6f8298 (patch)
tree3fe9a9d9ab83871f2562841b65fcfd3477ee90a0
parent9c3b2760688aca748f81529d0b055f799959ab4b (diff)
downloadpyramid-c03dbcca24aeedfb688bf49b7ccfeef20f6f8298.tar.gz
pyramid-c03dbcca24aeedfb688bf49b7ccfeef20f6f8298.tar.bz2
pyramid-c03dbcca24aeedfb688bf49b7ccfeef20f6f8298.zip
convert zcml docs to Pyramid
-rw-r--r--docs/zcml.rst4
l---------docs/zcml/.#include.rst1
-rw-r--r--docs/zcml/aclauthorizationpolicy.rst4
-rw-r--r--docs/zcml/authtktauthenticationpolicy.rst6
-rw-r--r--docs/zcml/configure.rst38
-rw-r--r--docs/zcml/default_permission.rst6
-rw-r--r--docs/zcml/forbidden.rst18
-rw-r--r--docs/zcml/localenegotiator.rst4
-rw-r--r--docs/zcml/notfound.rst18
-rw-r--r--docs/zcml/remoteuserauthenticationpolicy.rst6
-rw-r--r--docs/zcml/renderer.rst2
-rw-r--r--docs/zcml/repozewho1authenticationpolicy.rst6
-rw-r--r--docs/zcml/resource.rst2
-rw-r--r--docs/zcml/route.rst34
-rw-r--r--docs/zcml/scan.rst4
-rw-r--r--docs/zcml/static.rst4
-rw-r--r--docs/zcml/subscriber.rst8
-rw-r--r--docs/zcml/translationdir.rst4
-rw-r--r--docs/zcml/view.rst32
19 files changed, 67 insertions, 134 deletions
diff --git a/docs/zcml.rst b/docs/zcml.rst
index 9a41b8bcc..2a17f5a28 100644
--- a/docs/zcml.rst
+++ b/docs/zcml.rst
@@ -4,8 +4,8 @@ ZCML Directives
===============
Comprehensive reference material for every ZCML directive provided by
-:mod:`repoze.bfg` is available within this chapter. The ZCML
-directive documentation is organized alphabetically by directive name.
+:mod:`pyramid` is available within this chapter. The ZCML directive
+documentation is organized alphabetically by directive name.
.. toctree::
:maxdepth: 1
diff --git a/docs/zcml/.#include.rst b/docs/zcml/.#include.rst
new file mode 120000
index 000000000..0e27a9e93
--- /dev/null
+++ b/docs/zcml/.#include.rst
@@ -0,0 +1 @@
+chrism@thinko.17096:1287927276 \ No newline at end of file
diff --git a/docs/zcml/aclauthorizationpolicy.rst b/docs/zcml/aclauthorizationpolicy.rst
index f4df1dce1..7eecf6c6e 100644
--- a/docs/zcml/aclauthorizationpolicy.rst
+++ b/docs/zcml/aclauthorizationpolicy.rst
@@ -23,8 +23,8 @@ Alternatives
~~~~~~~~~~~~
You may create an instance of the
-:class:`repoze.bfg.authorization.ACLAuthorizationPolicy` and pass it
-to the :class:`repoze.bfg.configuration.Configurator` constructor as
+:class:`pyramid.authorization.ACLAuthorizationPolicy` and pass it
+to the :class:`pyramid.configuration.Configurator` constructor as
the ``authorization_policy`` argument during initial application
configuration.
diff --git a/docs/zcml/authtktauthenticationpolicy.rst b/docs/zcml/authtktauthenticationpolicy.rst
index 79fec1406..fd97a42eb 100644
--- a/docs/zcml/authtktauthenticationpolicy.rst
+++ b/docs/zcml/authtktauthenticationpolicy.rst
@@ -90,8 +90,8 @@ Alternatives
~~~~~~~~~~~~
You may create an instance of the
-:class:`repoze.bfg.authentication.AuthTktAuthenticationPolicy` and
-pass it to the :class:`repoze.bfg.configuration.Configurator`
+:class:`pyramid.authentication.AuthTktAuthenticationPolicy` and
+pass it to the :class:`pyramid.configuration.Configurator`
constructor as the ``authentication_policy`` argument during initial
application configuration.
@@ -99,4 +99,4 @@ See Also
~~~~~~~~
See also :ref:`authentication_policies_directives_section` and
-:class:`repoze.bfg.authentication.AuthTktAuthenticationPolicy`.
+:class:`pyramid.authentication.AuthTktAuthenticationPolicy`.
diff --git a/docs/zcml/configure.rst b/docs/zcml/configure.rst
index 7b479b2c0..db8219a2d 100644
--- a/docs/zcml/configure.rst
+++ b/docs/zcml/configure.rst
@@ -4,7 +4,7 @@
-------------
Because :term:`ZCML` is XML, and because XML requires a single root
-tag for each document, every ZCML file used by :mod:`repoze.bfg` must
+tag for each document, every ZCML file used by :mod:`pyramid` must
contain a ``configure`` container directive, which acts as the root
XML tag. It is a "container" directive because its only job is to
contain other directives.
@@ -21,7 +21,7 @@ Example
.. code-block:: xml
:linenos:
- <configure xmlns="http://namespaces.repoze.org/bfg">
+ <configure xmlns="http://pylonshq.com/pyramid">
<!-- other directives -->
@@ -34,17 +34,17 @@ A Word On XML Namespaces
Usually, the start tag of the ``<configure>`` container tag has a
default *XML namespace* associated with it. This is usually
-``http://namespaces.repoze.org/bfg``, named by the ``xmlns`` attribute
-of the ``configure`` start tag.
-
-Using the ``http://namespaces.repoze.org/bfg`` namespace as the
-default XML namespace isn't strictly necessary; you can use a
-different default namespace as the default. However, if you do, the
-declaration tags which are defined by :mod:`repoze.bfg` such as the
-``view`` declaration tag will need to be defined in such a way that
-the XML parser that :mod:`repoze.bfg` uses knows which namespace the
-:mod:`repoze.bfg` tags are associated with. For example, the
-following files are all completely equivalent:
+``http://pylonshq.com/pyramid``, named by the ``xmlns`` attribute of
+the ``configure`` start tag.
+
+Using the ``http://pylonshq.com/pyramid`` namespace as the default XML
+namespace isn't strictly necessary; you can use a different default
+namespace as the default. However, if you do, the declaration tags
+which are defined by :mod:`pyramid` such as the ``view`` declaration
+tag will need to be defined in such a way that the XML parser that
+:mod:`pyramid` uses knows which namespace the :mod:`pyramid` tags are
+associated with. For example, the following files are all completely
+equivalent:
.. topic:: Use of A Non-Default XML Namespace
@@ -52,11 +52,11 @@ following files are all completely equivalent:
:linenos:
<configure xmlns="http://namespaces.zope.org/zope"
- xmlns:bfg="http://namespaces.repoze.org/bfg">
+ xmlns:pyramid="http://pylonshq.com/pyramid">
- <include package="repoze.bfg.includes" />
+ <include package="pyramid.includes" />
- <bfg:view
+ <pyramid:view
view="helloworld.hello_world"
/>
@@ -69,9 +69,9 @@ following files are all completely equivalent:
<configure>
- <include package="repoze.bfg.includes" />
+ <include package="pyramid.includes" />
- <view xmlns="http://namespaces.repoze.org/bfg"
+ <view xmlns="http://pylonshq.com/pyramid"
view="helloworld.hello_world"
/>
@@ -81,7 +81,7 @@ For more information about XML namespaces, see `this older, but simple
XML.com article <http://www.xml.com/pub/a/1999/01/namespaces.html>`_.
The conventions in this document assume that the default XML namespace
-is ``http://namespaces.repoze.org/bfg``.
+is ``http://pylonshq.com/pyramid``.
Alternatives
~~~~~~~~~~~~
diff --git a/docs/zcml/default_permission.rst b/docs/zcml/default_permission.rst
index 2bac99158..beb60db1a 100644
--- a/docs/zcml/default_permission.rst
+++ b/docs/zcml/default_permission.rst
@@ -21,8 +21,6 @@ There can be only one default permission active at a time within an
application, thus the ``default_permission`` directive can only be
used once in any particular set of ZCML.
-.. note: This API is new as of :mod:`repoze.bfg` version 1.3.
-
Attributes
~~~~~~~~~~
@@ -45,11 +43,11 @@ Alternatives
~~~~~~~~~~~~
Using the ``default_permission`` argument to the
-:class:`repoze.bfg.configuration.Configurator` constructor can be used
+:class:`pyramid.configuration.Configurator` constructor can be used
to achieve the same purpose.
Using the
-:meth:`repoze.bfg.configuration.Configurator.set_default_permission`
+:meth:`pyramid.configuration.Configurator.set_default_permission`
method can be used to achieve the same purpose when using imperative
configuration.
diff --git a/docs/zcml/forbidden.rst b/docs/zcml/forbidden.rst
index 5a52a05ab..ca5b2cca1 100644
--- a/docs/zcml/forbidden.rst
+++ b/docs/zcml/forbidden.rst
@@ -3,7 +3,7 @@
``forbidden``
-------------
-When :mod:`repoze.bfg` can't authorize execution of a view based on
+When :mod:`pyramid` can't authorize execution of a view based on
the :term:`authorization policy` in use, it invokes a :term:`forbidden
view`. The default forbidden response has a 401 status code and is
very plain, but it can be overridden as necessary using the
@@ -11,10 +11,10 @@ very plain, but it can be overridden as necessary using the
.. warning::
- The ``forbidden`` ZCML directive is deprecated in :mod:`repoze.bfg`
+ The ``forbidden`` ZCML directive is deprecated in :mod:`pyramid`
version 1.3. Instead, you should use the :ref:`view_directive`
directive with a ``context`` that names the
- :exc:`repoze.bfg.exceptions.Forbidden` class. See
+ :exc:`pyramid.exceptions.Forbidden` class. See
:ref:`changing_the_forbidden_view` form more information.
Attributes
@@ -33,8 +33,6 @@ Attributes
:ref:`view_directive`; see the description of ``attr``
there).
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``renderer``
This is either a single string term (e.g. ``json``) or a string
implying a path or :term:`resource specification`
@@ -43,8 +41,6 @@ Attributes
it would in the context of :ref:`view_directive`; see the
description of ``renderer`` there).
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``wrapper``
The :term:`view name` (*not* an object dotted name) of another view
declared elsewhere in ZCML (or via the ``@bfg_view`` decorator)
@@ -57,8 +53,6 @@ Attributes
*should not* be protected by any permission; behavior is undefined
if it does.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
Example
~~~~~~~
@@ -72,11 +66,11 @@ Alternatives
~~~~~~~~~~~~
Use the :ref:`view_directive` directive with a ``context`` that names
-the :exc:`repoze.bfg.exceptions.Forbidden` class.
+the :exc:`pyramid.exceptions.Forbidden` class.
-Use the :meth:`repoze.bfg.configuration.Configurator.add_view` method,
+Use the :meth:`pyramid.configuration.Configurator.add_view` method,
passing it a ``context`` which is the
-:exc:`repoze.bfg.exceptions.Forbidden` class.
+:exc:`pyramid.exceptions.Forbidden` class.
See Also
~~~~~~~~
diff --git a/docs/zcml/localenegotiator.rst b/docs/zcml/localenegotiator.rst
index 59dcf32c2..100fa837a 100644
--- a/docs/zcml/localenegotiator.rst
+++ b/docs/zcml/localenegotiator.rst
@@ -6,8 +6,6 @@
Set the :term:`locale negotiator` for the current configurator to
support localization of text.
-.. note: This ZCML directive is new as of :mod:`repoze.bfg` version 1.3.
-
Attributes
~~~~~~~~~~
@@ -31,7 +29,7 @@ Example
Alternatives
~~~~~~~~~~~~
-Use :meth:`repoze.bfg.configuration.Configurator.set_locale_negotiator`
+Use :meth:`pyramid.configuration.Configurator.set_locale_negotiator`
method instance during initial application setup.
See Also
diff --git a/docs/zcml/notfound.rst b/docs/zcml/notfound.rst
index 3fe9900d4..59263db34 100644
--- a/docs/zcml/notfound.rst
+++ b/docs/zcml/notfound.rst
@@ -5,13 +5,13 @@
.. warning::
- The ``notfound`` ZCML directive is deprecated in :mod:`repoze.bfg`
+ The ``notfound`` ZCML directive is deprecated in :mod:`pyramid`
version 1.3. Instead, you should use the :ref:`view_directive`
directive with a ``context`` that names the
- :exc:`repoze.bfg.exceptions.NotFound` class. See
+ :exc:`pyramid.exceptions.NotFound` class. See
:ref:`changing_the_notfound_view` form more information.
-When :mod:`repoze.bfg` can't map a URL to view code, it invokes a
+When :mod:`pyramid` can't map a URL to view code, it invokes a
:term:`not found view`. The default not found view is very plain, but
the view callable used can be configured via the ``notfound`` ZCML
tag.
@@ -32,8 +32,6 @@ Attributes
:ref:`view_directive`; see the description of ``attr``
there).
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``renderer``
This is either a single string term (e.g. ``json``) or a string
implying a path or :term:`resource specification`
@@ -42,8 +40,6 @@ Attributes
it would in the context of :ref:`view_directive`; see the
description of ``renderer`` there).
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``wrapper``
The :term:`view name` (*not* an object dotted name) of another view
declared elsewhere in ZCML (or via the ``@bfg_view`` decorator)
@@ -56,8 +52,6 @@ Attributes
*should not* be protected by any permission; behavior is undefined
if it does.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
Example
~~~~~~~
@@ -71,11 +65,11 @@ Alternatives
~~~~~~~~~~~~
Use the :ref:`view_directive` directive with a ``context`` that names
-the :exc:`repoze.bfg.exceptions.NotFound` class.
+the :exc:`pyramid.exceptions.NotFound` class.
-Use the :meth:`repoze.bfg.configuration.Configurator.add_view` method,
+Use the :meth:`pyramid.configuration.Configurator.add_view` method,
passing it a ``context`` which is the
-:exc:`repoze.bfg.exceptions.NotFound` class.
+:exc:`pyramid.exceptions.NotFound` class.
See Also
~~~~~~~~
diff --git a/docs/zcml/remoteuserauthenticationpolicy.rst b/docs/zcml/remoteuserauthenticationpolicy.rst
index 0435bfbdb..d21cd99d2 100644
--- a/docs/zcml/remoteuserauthenticationpolicy.rst
+++ b/docs/zcml/remoteuserauthenticationpolicy.rst
@@ -39,8 +39,8 @@ Alternatives
~~~~~~~~~~~~
You may create an instance of the
-:class:`repoze.bfg.authentication.RemoteUserAuthenticationPolicy` and
-pass it to the :class:`repoze.bfg.configuration.Configurator`
+:class:`pyramid.authentication.RemoteUserAuthenticationPolicy` and
+pass it to the :class:`pyramid.configuration.Configurator`
constructor as the ``authentication_policy`` argument during initial
application configuration.
@@ -48,4 +48,4 @@ See Also
~~~~~~~~
See also :ref:`authentication_policies_directives_section` and
-:class:`repoze.bfg.authentication.RemoteUserAuthenticationPolicy`.
+:class:`pyramid.authentication.RemoteUserAuthenticationPolicy`.
diff --git a/docs/zcml/renderer.rst b/docs/zcml/renderer.rst
index 5eb4f03f8..67c2a7f0c 100644
--- a/docs/zcml/renderer.rst
+++ b/docs/zcml/renderer.rst
@@ -42,7 +42,7 @@ Examples
Alternatives
~~~~~~~~~~~~
-The :meth:`repoze.bfg.configuration.Configurator.add_renderer` method
+The :meth:`pyramid.configuration.Configurator.add_renderer` method
is equivalent to the ``renderer`` ZCML directive.
See Also
diff --git a/docs/zcml/repozewho1authenticationpolicy.rst b/docs/zcml/repozewho1authenticationpolicy.rst
index 62713e822..e5152f2e1 100644
--- a/docs/zcml/repozewho1authenticationpolicy.rst
+++ b/docs/zcml/repozewho1authenticationpolicy.rst
@@ -41,8 +41,8 @@ Alternatives
~~~~~~~~~~~~
You may create an instance of the
-:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy` and
-pass it to the :class:`repoze.bfg.configuration.Configurator`
+:class:`pyramid.authentication.RepozeWho1AuthenticationPolicy` and
+pass it to the :class:`pyramid.configuration.Configurator`
constructor as the ``authentication_policy`` argument during initial
application configuration.
@@ -50,4 +50,4 @@ See Also
~~~~~~~~
See also :ref:`authentication_policies_directives_section` and
-:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy`.
+:class:`pyramid.authentication.RepozeWho1AuthenticationPolicy`.
diff --git a/docs/zcml/resource.rst b/docs/zcml/resource.rst
index 80a5e6722..4cf5ef400 100644
--- a/docs/zcml/resource.rst
+++ b/docs/zcml/resource.rst
@@ -53,7 +53,7 @@ Examples
Alternatives
~~~~~~~~~~~~
-The :meth:`repoze.bfg.configuration.Configurator.override_resource`
+The :meth:`pyramid.configuration.Configurator.override_resource`
method can be used instead of the ``resource`` ZCML directive.
See Also
diff --git a/docs/zcml/route.rst b/docs/zcml/route.rst
index 4290ea3ae..ad746cba7 100644
--- a/docs/zcml/route.rst
+++ b/docs/zcml/route.rst
@@ -15,8 +15,7 @@ Attributes
about the syntax of route patterns.
.. note:: For backwards compatibility purposes, the ``path``
- attribute can also be used instead of ``pattern``. ``pattern``
- is the preferred spelling as of :mod:`repoze.bfg` 1.3.
+ attribute can also be used instead of ``pattern``.
``name``
The name of the route, e.g. ``myroute``. This attribute is
@@ -25,7 +24,7 @@ Attributes
``factory``
The :term:`dotted Python name` to a function that will generate a
- :mod:`repoze.bfg` context object when this route matches.
+ :mod:`pyramid` context object when this route matches.
e.g. ``mypackage.models.MyFactoryClass``. If this argument is not
specified, a default root factory will be used.
@@ -42,8 +41,6 @@ Attributes
from jQuery, Prototype and other Javascript libraries. If this
predicate returns false, route matching continues.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``traverse``
If you would like to cause the :term:`context` to be something other
than the :term:`root` object when this route matches, you can spell
@@ -82,24 +79,18 @@ Attributes
ignored when attached to a route that has a ``*traverse`` remainder
marker in its pattern.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.3.
-
``request_method``
A string representing an HTTP method name, e.g. ``GET``, ``POST``,
``HEAD``, ``DELETE``, ``PUT``. If this argument is not specified,
this route will match if the request has *any* request method. If
this predicate returns false, route matching continues.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``path_info``
The value of this attribute represents a regular expression pattern
that will be tested against the ``PATH_INFO`` WSGI environment
variable. If the regex matches, this predicate will be true. If
this predicate returns false, route matching continues.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``request_param``
This value can be any string. A view declaration with this
attribute ensures that the associated route will only match when the
@@ -112,8 +103,6 @@ Attributes
for the route to "match" the current request. If this predicate
returns false, route matching continues.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``header``
The value of this attribute represents an HTTP header name or a
header name/value pair. If the value contains a ``:`` (colon), it
@@ -132,8 +121,6 @@ Attributes
significant. If this predicate returns false, route matching
continues.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``accept``
The value of this attribute represents a match query for one or more
mimetypes in the ``Accept`` HTTP request header. If this value is
@@ -144,8 +131,6 @@ Attributes
``Accept`` header of the request, this predicate will be true. If
this predicate returns false, route matching continues.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``custom_predicates``
This value should be a sequence of references to custom predicate
@@ -162,13 +147,6 @@ Attributes
containing matching information; see :ref:`custom_route_predicates`
for more information about ``info``.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.2.
-
- .. note:: The ``info`` argument passed to a custom predicate in
- versions prior to :mod:`repoze.bfg` 1.3 was always
- ``None``.
-
-
``view_context``
The :term:`dotted Python name` to a class or an interface that the
:term:`context` of the view should match for the view named by the
@@ -212,8 +190,6 @@ Attributes
This attribute can also be spelled as ``renderer``.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``view_attr``
The view machinery defaults to using the ``__call__`` method of the
view callable (or the function itself, if the view callable is a
@@ -228,22 +204,18 @@ Attributes
If the ``view`` attribute is not provided, this attribute has no
effect.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``use_global_views``
When a request matches this route, and view lookup cannot find a view
which has a 'route_name' predicate argument that matches the route,
try to fall back to using a view that otherwise matches the context,
request, and view name (but does not match the route name predicate).
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.2.
-
Alternatives
~~~~~~~~~~~~
You can also add a :term:`route configuration` via:
-- Using the :meth:`repoze.bfg.configuration.Configurator.add_route` method.
+- Using the :meth:`pyramid.configuration.Configurator.add_route` method.
See Also
~~~~~~~~
diff --git a/docs/zcml/scan.rst b/docs/zcml/scan.rst
index 679f035e2..103098b9f 100644
--- a/docs/zcml/scan.rst
+++ b/docs/zcml/scan.rst
@@ -5,7 +5,7 @@
To make use of :term:`configuration decoration` decorators, you must
perform a :term:`scan`. A scan finds these decorators in code. The
-``scan`` ZCML directive tells :mod:`repoze.bfg` to begin such a scan.
+``scan`` ZCML directive tells :mod:`pyramid` to begin such a scan.
Attributes
~~~~~~~~~~
@@ -25,7 +25,7 @@ Example
Alternatives
~~~~~~~~~~~~
-The :meth:`repoze.bfg.configuration.Configurator.scan` method performs
+The :meth:`pyramid.configuration.Configurator.scan` method performs
the same job as the ``scan`` ZCML directive.
See Also
diff --git a/docs/zcml/static.rst b/docs/zcml/static.rst
index 1a11f222c..6c1c5b6d3 100644
--- a/docs/zcml/static.rst
+++ b/docs/zcml/static.rst
@@ -5,7 +5,7 @@
Use of the ``static`` ZCML directive or allows you to serve static
resources (such as JavaScript and CSS files) within a
-:mod:`repoze.bfg` application. This mechanism makes static files
+:mod:`pyramid` application. This mechanism makes static files
available at a name relative to the application root URL.
Attributes
@@ -65,7 +65,7 @@ Examples
Alternatives
~~~~~~~~~~~~
-:meth:`repoze.bfg.configuration.configurator.add_static_view` can also
+:meth:`pyramid.configuration.configurator.add_static_view` can also
be used to add a static view.
See Also
diff --git a/docs/zcml/subscriber.rst b/docs/zcml/subscriber.rst
index 371ec0752..c48c89a9b 100644
--- a/docs/zcml/subscriber.rst
+++ b/docs/zcml/subscriber.rst
@@ -4,7 +4,7 @@
--------------
The ``subscriber`` ZCML directive configures an :term:`subscriber`
-callable to listen for events broadcast by the :mod:`repoze.bfg` web
+callable to listen for events broadcast by the :mod:`pyramid` web
framework.
Attributes
@@ -12,7 +12,7 @@ Attributes
``for``
The class or :term:`interface` that you are subscribing the
- listener for, e.g. :class:`repoze.bfg.interfaces.INewRequest`.
+ listener for, e.g. :class:`pyramid.interfaces.INewRequest`.
Registering a subscriber for a specific class or interface limits
the event types that the subscriber will receive to those specified
by the interface or class. Default: ``zope.interface.Interface``
@@ -30,7 +30,7 @@ Examples
:linenos:
<subscriber
- for="repoze.bfg.interfaces.INewRequest"
+ for="pyramid.interfaces.INewRequest"
handler=".subscribers.handle_new_request"
/>
@@ -38,7 +38,7 @@ Alternatives
~~~~~~~~~~~~
You can also register an event listener by using the
-:meth:`repoze.bfg.configuration.Configurator.add_subscriber` method.
+:meth:`pyramid.configuration.Configurator.add_subscriber` method.
See Also
~~~~~~~~
diff --git a/docs/zcml/translationdir.rst b/docs/zcml/translationdir.rst
index 5c69cb737..56c0977db 100644
--- a/docs/zcml/translationdir.rst
+++ b/docs/zcml/translationdir.rst
@@ -6,8 +6,6 @@
Add a :term:`gettext` :term:`translation directory` to the current
configuration for use in localization of text.
-.. note: This ZCML directive is new as of :mod:`repoze.bfg` version 1.3.
-
Attributes
~~~~~~~~~~
@@ -57,7 +55,7 @@ Example 3
Alternatives
~~~~~~~~~~~~
-Use :meth:`repoze.bfg.configuration.Configurator.add_translation_dirs`
+Use :meth:`pyramid.configuration.Configurator.add_translation_dirs`
method instance during initial application setup.
See Also
diff --git a/docs/zcml/view.rst b/docs/zcml/view.rst
index d33a9a9a5..041e35af5 100644
--- a/docs/zcml/view.rst
+++ b/docs/zcml/view.rst
@@ -3,7 +3,7 @@
``view``
--------
-A ``view`` declaration directs :mod:`repoze.bfg` to create a single
+A ``view`` declaration directs :mod:`pyramid` to create a single
:term:`view configuration` registration in the current
:term:`application registry`.
@@ -49,8 +49,6 @@ Non-Predicate Attributes
``attr="index"`` in the view configuration for the view. This is
most useful when the view definition is a class.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``renderer``
This is either a single string term (e.g. ``json``) or a string
implying a path or :term:`resource specification`
@@ -83,8 +81,6 @@ Non-Predicate Attributes
"null" renderer is assumed (no rendering is performed and the value
is passed back to the upstream BFG machinery unmolested).
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``wrapper``
The :term:`view name` (*not* an object dotted name) of another view
declared elsewhere in ZCML (or via the ``@bfg_view`` decorator)
@@ -97,13 +93,11 @@ Non-Predicate Attributes
wrapper view will be found as any view is found: see
:ref:`view_lookup`. The "best" wrapper view will be found based on
the lookup ordering: "under the hood" this wrapper view is looked up
- via ``repoze.bfg.view.render_view_to_response(context, request,
+ via ``pyramid.view.render_view_to_response(context, request,
'wrapper_viewname')``. The context and request of a wrapper view is
the same context and request of the inner view. If this attribute
is unspecified, no view wrapping is done.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
Predicate Attributes
####################
@@ -138,7 +132,7 @@ Predicate Attributes
representing the :term:`interface` that the :term:`request` must
have in order for this view to be found and called. The presence of
this attribute is largely for backwards compatibility with
- applications written for :mod:`repoze.bfg` version 1.0. This value
+ older iterations of this framework. This value
may be an HTTP ``REQUEST_METHOD`` string, e.g. ('GET', 'HEAD',
'PUT', 'POST', or 'DELETE'). Passing request method strings as a
``request_type`` is deprecated. Use the ``request_method``
@@ -151,8 +145,6 @@ Predicate Attributes
called when the request's ``method`` (aka ``REQUEST_METHOD``) string
matches the supplied value.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``request_param``
This value can be any string. A view declaration with this
attribute ensures that the view will only be called when the request
@@ -164,8 +156,6 @@ Predicate Attributes
the right hand side of the expression (``123``) for the view to
"match" the current request.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``containment``
This value should be a :term:`dotted Python name` string
representing the class that a graph traversal parent object of the
@@ -175,8 +165,6 @@ Predicate Attributes
See :ref:`location_aware` for more information about
location-awareness.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``xhr``
This value should be either ``True`` or ``False``. If this value is
specified and is ``True``, the :term:`request` must possess an
@@ -185,8 +173,6 @@ Predicate Attributes
This is useful for detecting AJAX requests issued from jQuery,
Prototype and other Javascript libraries.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``accept``
The value of this attribute represents a match query for one or more
mimetypes in the ``Accept`` HTTP request header. If this value is
@@ -196,8 +182,6 @@ Predicate Attributes
token in the form ``*/*``. If any of the forms matches the
``Accept`` header of the request, this predicate will be true.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``header``
The value of this attribute represents an HTTP header name or a
header name/value pair. If the value contains a ``:`` (colon), it
@@ -215,15 +199,11 @@ Predicate Attributes
header name/value pair, the case of the header name is not
significant.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``path_info``
The value of this attribute represents a regular expression pattern
that will be tested against the ``PATH_INFO`` WSGI environment
variable. If the regex matches, this predicate will be true.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.1.
-
``custom_predicates``
This value should be a sequence of references to custom predicate
callables (e.g. ``dotted.name.one dotted.name.two``, if used in
@@ -237,8 +217,6 @@ Predicate Attributes
associated view callable will be considered viable for a given
request.
- .. note:: This feature is new as of :mod:`repoze.bfg` 1.2.
-
Examples
~~~~~~~~
@@ -268,9 +246,9 @@ Alternatives
You can also add a :term:`view configuration` via:
-- Using the :class:`repoze.bfg.view.bfg_view` class as a decorator.
+- Using the :class:`pyramid.view.bfg_view` class as a decorator.
-- Using the :meth:`repoze.bfg.configuration.Configurator.add_view` method.
+- Using the :meth:`pyramid.configuration.Configurator.add_view` method.
See Also
~~~~~~~~