diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/glossary.rst | 4 | ||||
| -rw-r--r-- | docs/narr/MyProject/myproject/configure.zcml | 6 | ||||
| -rw-r--r-- | docs/narr/events.rst | 4 | ||||
| -rw-r--r-- | docs/narr/security.rst | 2 | ||||
| -rw-r--r-- | docs/narr/unittesting.rst | 6 | ||||
| -rw-r--r-- | docs/narr/urldispatch.rst | 4 | ||||
| -rw-r--r-- | docs/narr/views.rst | 30 | ||||
| -rw-r--r-- | docs/tutorials/lxmlgraph/step01/myapp/configure.zcml | 7 | ||||
| -rw-r--r-- | docs/tutorials/lxmlgraph/step02/myapp/configure.zcml | 7 | ||||
| -rw-r--r-- | docs/tutorials/lxmlgraph/step03.rst | 8 | ||||
| -rw-r--r-- | docs/tutorials/lxmlgraph/step03/myapp/configure.zcml | 9 | ||||
| -rw-r--r-- | docs/tutorials/lxmlgraph/step04/myapp/configure.zcml | 7 |
12 files changed, 43 insertions, 51 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index 92286dfb1..c15f94883 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -240,7 +240,7 @@ Glossary used by Zope and :mod:`repoze.bfg` to describe associating a view with a model type. ZCML is capable of performing many different registrations and declarations, but its primary purpose in - :mod:`repoze.bfg` is to perform view mappings via the ``bfg:view`` + :mod:`repoze.bfg` is to perform view mappings via the ``view`` declaration. The ``configure.zcml`` file in a :mod:`repoze.bfg` application represents the application's :term:`application registry`. See :term:`repoze.bfg.convention` for an alternative @@ -259,7 +259,7 @@ Glossary or a request object in order to identify that the object is "of a type". Interfaces are used internally by :mod:`repoze.bfg` to perform view lookups and security policy lookups. Interfaces are - exposed to application programmers by the ``bfg:view`` ZCML + exposed to application programmers by the ``view`` ZCML directive in the form of both the ``for_`` attribute and the ``request_type`` attribute. They may be exposed to application developers when using the :term:`event` system as diff --git a/docs/narr/MyProject/myproject/configure.zcml b/docs/narr/MyProject/myproject/configure.zcml index 96f51d3c1..584dee906 100644 --- a/docs/narr/MyProject/myproject/configure.zcml +++ b/docs/narr/MyProject/myproject/configure.zcml @@ -1,11 +1,9 @@ -<configure xmlns="http://namespaces.zope.org/zope" - xmlns:bfg="http://namespaces.repoze.org/bfg" - i18n_domain="repoze.bfg"> +<configure xmlns="http://namespaces.repoze.org/bfg"> <!-- this must be included for the view declarations to work --> <include package="repoze.bfg.includes" /> - <bfg:view + <view for=".models.MyModel" view=".views.my_view" /> diff --git a/docs/narr/events.rst b/docs/narr/events.rst index c6242c25d..adb0ae7b0 100644 --- a/docs/narr/events.rst +++ b/docs/narr/events.rst @@ -152,13 +152,13 @@ the same model object. /> <!-- html default view --> - <bfg:view + <view for=".models.MyModel" request_type="repoze.bfg.interfaces.IRequest" view=".views.html_view"/> <!-- JSON default view --> - <bfg:view + <view for=".models.MyModel" request_type=".interfaces.IJSONRequest" view=".views.json_view"/> diff --git a/docs/narr/security.rst b/docs/narr/security.rst index 041fff89d..87eaeae0a 100644 --- a/docs/narr/security.rst +++ b/docs/narr/security.rst @@ -50,7 +50,7 @@ For example, the following declaration protects the view named .. code-block:: xml :linenos: - <bfg:view + <view for=".models.IBlog" view=".views.blog_entry_add_view" name="add_entry.html" diff --git a/docs/narr/unittesting.rst b/docs/narr/unittesting.rst index b3b2321dd..165e92411 100644 --- a/docs/narr/unittesting.rst +++ b/docs/narr/unittesting.rst @@ -31,9 +31,9 @@ this view function will result in an error. When a :mod:`repoze.bfg` application starts normally, it will create an application registry from the information it finds in the application's ``configure.zcml`` file. But if this application registry is not created and populated -(e.g. with ``bfg:view`` statements), like when you invoke application -code via a unit test, :mod:`repoze.bfg` API functions will tend to -fail. +(e.g. with ``view`` declarations in ZCML), like when you invoke +application code via a unit test, :mod:`repoze.bfg` API functions will +tend to fail. The testing API provided by ``repoze.bfg`` allows you to simulate various application registry registrations for use under a unit diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst index e1f07f88e..7572ddd65 100644 --- a/docs/narr/urldispatch.rst +++ b/docs/narr/urldispatch.rst @@ -134,14 +134,14 @@ call the "fallback" ``get_root`` callable provided to it above. Example 2 --------- -An example of configuring a ``bfg:view`` stanza in ``configure.zcml`` +An example of configuring a ``view`` declaration in ``configure.zcml`` that maps a context found via :term:`Routes` URL dispatch to a view function is as follows: .. code-block:: xml :linenos: - <bfg:view + <view for="repoze.bfg.interfaces.IRoutesContext" view=".views.articles_view" name="articles" diff --git a/docs/narr/views.rst b/docs/narr/views.rst index d61cdb06e..9e2d2887f 100644 --- a/docs/narr/views.rst +++ b/docs/narr/views.rst @@ -66,12 +66,12 @@ Mapping Views to URLs You may associate a view with a URL by adding information to your :term:`application registry` via :term:`ZCML` in your -``configure.zcml`` file using a ``bfg:view`` declaration. +``configure.zcml`` file using a ``view`` declaration. .. code-block:: xml :linenos: - <bfg:view + <view for=".models.Hello" view=".views.hello_world" name="hello.html" @@ -83,9 +83,9 @@ Python class represented by ``.models.Hello`` when the *view name* is ``hello.html``. .. note:: Values prefixed with a period (``.``)for the ``for`` and - ``view`` attributes of a ``bfg:view`` (such as those above) mean + ``view`` attributes of a ``view`` (such as those above) mean "relative to the Python package directory in which this - :term:`ZCML` file is stored". So if the above ``bfg:view`` + :term:`ZCML` file is stored". So if the above ``view`` declaration was made inside a ``configure.zcml`` file that lived in the ``hello`` package, you could replace the relative ``.models.Hello`` with the absolute ``hello.models.Hello``; @@ -100,7 +100,7 @@ You can also declare a *default view* for a model type: .. code-block:: xml :linenos: - <bfg:view + <view for=".models.Hello" view=".views.hello_world" /> @@ -115,7 +115,7 @@ the special ``*`` character in the ``for`` attribute: .. code-block:: xml :linenos: - <bfg:view + <view for="*" view=".views.hello_world" name="hello.html" @@ -204,7 +204,7 @@ this interface. .. code-block:: xml :linenos: - <bfg:view + <view for=".models.IHello" view=".views.hello_world" name="hello.html" @@ -223,10 +223,10 @@ implemented by the context, the view registered for the class will See :term:`Interface` in the glossary to find more information about interfaces. -The ``bfg:view`` ZCML Element ------------------------------ +The ``view`` ZCML Element +------------------------- -The ``bfg:view`` ZCML element has these possible attributes: +The ``view`` ZCML element has these possible attributes: view @@ -262,14 +262,14 @@ request_type View Request Types ------------------ -You can optionally add a *request_type* attribute to your ``bfg:view`` +You can optionally add a *request_type* attribute to your ``view`` declaration, which indicates what "kind" of request the view should be used for. For example: .. code-block:: xml :linenos: - <bfg:view + <view for=".models.IHello" view=".views.hello_json" name="hello.json" @@ -325,16 +325,16 @@ View Security ------------- If a :term:`security policy` is active, any :term:`permission` -attached to a ``bfg:view`` declaration will be consulted to ensure +attached to a ``view`` declaration will be consulted to ensure that the currently authenticated user possesses that permission against the context before the view function is actually called. -Here's an example of specifying a permission in a ``bfg:view`` +Here's an example of specifying a permission in a ``view`` declaration: .. code-block:: xml :linenos: - <bfg:view + <view for=".models.IBlog" view=".views.add_entry" name="add.html" diff --git a/docs/tutorials/lxmlgraph/step01/myapp/configure.zcml b/docs/tutorials/lxmlgraph/step01/myapp/configure.zcml index b139396fa..e06023c24 100644 --- a/docs/tutorials/lxmlgraph/step01/myapp/configure.zcml +++ b/docs/tutorials/lxmlgraph/step01/myapp/configure.zcml @@ -1,11 +1,10 @@ -<configure xmlns="http://namespaces.zope.org/zope" - xmlns:bfg="http://namespaces.repoze.org/bfg"> +<configure xmlns="http://namespaces.repoze.org/bfg"> <!-- this must be included for the view declarations to work --> - <include package="repoze.bfg" /> + <include package="repoze.bfg.includes" /> <!-- the default view for a MyModel --> - <bfg:view + <view for=".models.IMyModel" view=".views.my_hello_view" /> diff --git a/docs/tutorials/lxmlgraph/step02/myapp/configure.zcml b/docs/tutorials/lxmlgraph/step02/myapp/configure.zcml index d299dc883..2414ae6b2 100644 --- a/docs/tutorials/lxmlgraph/step02/myapp/configure.zcml +++ b/docs/tutorials/lxmlgraph/step02/myapp/configure.zcml @@ -1,9 +1,8 @@ -<configure xmlns="http://namespaces.zope.org/zope" - xmlns:bfg="http://namespaces.repoze.org/bfg"> +<configure xmlns="http://namespaces.repoze.org/bfg"> - <include package="repoze.bfg" /> + <include package="repoze.bfg.includes" /> - <bfg:view + <view for=".models.IMyModel" view=".views.my_view" /> diff --git a/docs/tutorials/lxmlgraph/step03.rst b/docs/tutorials/lxmlgraph/step03.rst index 0f54f8761..ce88b78c8 100644 --- a/docs/tutorials/lxmlgraph/step03.rst +++ b/docs/tutorials/lxmlgraph/step03.rst @@ -20,14 +20,12 @@ Change your project's ``configure.zcml`` so that it looks like this: .. code-block:: xml - <configure xmlns="http://namespaces.zope.org/zope" - xmlns:bfg="http://namespaces.repoze.org/bfg" - i18n_domain="repoze.bfg"> + <configure xmlns="http://namespaces.repoze.org/bfg"> <!-- this must be included for the view declarations to work --> - <include package="repoze.bfg" /> + <include package="repoze.bfg.includes" /> - <bfg:view + <view for=".models.IMyModel" view=".views.zpt_view" /> diff --git a/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml b/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml index 83d83ab61..43b766cfb 100644 --- a/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml +++ b/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml @@ -1,14 +1,13 @@ -<configure xmlns="http://namespaces.zope.org/zope" - xmlns:bfg="http://namespaces.repoze.org/bfg"> +<configure xmlns="http://namespaces.repoze.org/bfg"> - <include package="repoze.bfg" /> + <include package="repoze.bfg.includes" /> - <bfg:view + <view for=".models.IMyModel" view=".views.zpt_view" /> - <bfg:view + <view for=".models.IMyModel" view=".views.xslt_view" name="xsltview.html" diff --git a/docs/tutorials/lxmlgraph/step04/myapp/configure.zcml b/docs/tutorials/lxmlgraph/step04/myapp/configure.zcml index 1ba4c9155..c2d59effb 100644 --- a/docs/tutorials/lxmlgraph/step04/myapp/configure.zcml +++ b/docs/tutorials/lxmlgraph/step04/myapp/configure.zcml @@ -1,9 +1,8 @@ -<configure xmlns="http://namespaces.zope.org/zope" - xmlns:bfg="http://namespaces.repoze.org/bfg"> +<configure xmlns="http://namespaces.repoze.org/bfg"> - <include package="repoze.bfg" /> + <include package="repoze.bfg.includes" /> - <bfg:view + <view for=".models.IMyModel" view=".views.xslt_view" /> |