summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJason Madden <jamadden@gmail.com>2018-09-25 07:46:46 -0500
committerJason Madden <jamadden@gmail.com>2018-09-25 09:43:06 -0500
commit2158140c6970ebad54edc98e4798a1727663b920 (patch)
tree932374728d75a02e046b7f996f994cdbdc004b13 /src
parentcd96619be3714183270889b5f0037bebed8cb067 (diff)
downloadzope-configuration-2158140c6970ebad54edc98e4798a1727663b920.tar.gz
Document zcml:condition more thoroughly.
Also some cross-ref cleanups in narr.rst and zopeconfigure.py Fixes #5
Diffstat (limited to 'src')
-rw-r--r--src/zope/configuration/zopeconfigure.py52
1 files changed, 27 insertions, 25 deletions
diff --git a/src/zope/configuration/zopeconfigure.py b/src/zope/configuration/zopeconfigure.py
index 7204aeb..0d5f77b 100644
--- a/src/zope/configuration/zopeconfigure.py
+++ b/src/zope/configuration/zopeconfigure.py
@@ -33,14 +33,14 @@ To define a grouping directive, we need to do three things:
The parameter schema is given by IZopeConfigure. It specifies a
package parameter and an i18n_domain parameter. The package parameter
-is specified as a ``GlobalObject``. This means it must be given as a
+is specified as a `~.GlobalObject`. This means it must be given as a
dotted name that can be resolved through import. The i18n domain is
just a plain (not unicode) string.
The handler class has a constructor that takes a context to be adapted
and zero or more arguments (depending on the paramter schema). The
handler class must implement
-``zope.configuration.interfaces.IGroupingContext``, which defines
+`zope.configuration.interfaces.IGroupingContext`, which defines
hooks ``before`` and ``after``, that are called with no arguments
before and after nested directives are processed. If a grouping
directive handler creates any actions, or does any computation, this
@@ -48,13 +48,13 @@ is normally done in either the ``before`` or ``after`` hooks.
Grouping handlers are normally decorators.
The base class,
-``zope.configuration.config.GroupingContextDecorator``, is normally
+`zope.configuration.config.GroupingContextDecorator`, is normally
used to define grouping directive handlers. It provides:
-- An implementation of IConfigurationContext, which grouping directive
+- An implementation of `~.IConfigurationContext`, which grouping directive
handlers should normally implement,
-- A default implementation of ``IGroupingContext`` that provides empty
+- A default implementation of `~.IGroupingContext` that provides empty
hooks.
- Decorator support that uses a ``__getattr__`` method to delegate
@@ -63,32 +63,34 @@ used to define grouping directive handlers. It provides:
- A constructor that sets the ``context`` attribute to the adapted
context and assigns keyword arguments to attributes.
-The ``ZopeConfigure`` provides handling for the ``configure``
-directive. It subclasses GroupingContextDecorator, and overrides the
+The class `ZopeConfigure` provides handling for the ``configure``
+directive. It subclasses `~.GroupingContextDecorator`, and overrides the
constructor to set the ``basepath`` attribute if a ``package`` argument
is provided. Note that it delegates the job of assigning paramters to
-attribute to the ``GroupingContextDecorator`` constructor.
+attribute to the `~.GroupingContextDecorator` constructor.
The last step is to register the directive using the meta
configuration directive. If we wanted to register the Zope
``configure`` directive for the ``zope`` namespace, we'd use a
-meta-configuration directive like::
-
- <meta:groupingDirective
- namespace="http://namespaces.zope.org/zope"
- name="configure"
- schema="zope.configuration.zopeconfigure.IZopeConfigure"
- handler="zope.configuration.zopeconfigure.ZopeConfigure"
- >
- Zope configure
-
- The ``configure`` node is normally used as the root node for a
- configuration file. It can also be used to specify a package or
- internationalization domain for a group of directives within a
- file by grouping those directives.
- </meta:groupingDirective>
-
-We use the groupingDirective meta-directive to register a grouping
+meta-configuration directive like:
+
+.. code-block:: xml
+
+ <meta:groupingDirective
+ namespace="http://namespaces.zope.org/zope"
+ name="configure"
+ schema="zope.configuration.zopeconfigure.IZopeConfigure"
+ handler="zope.configuration.zopeconfigure.ZopeConfigure"
+ >
+ Zope configure
+
+ The ``configure`` node is normally used as the root node for a
+ configuration file. It can also be used to specify a package or
+ internationalization domain for a group of directives within a
+ file by grouping those directives.
+ </meta:groupingDirective>
+
+We use the ``groupingDirective`` meta-directive to register a grouping
directive. The parameters are self explanatory. The textual contents
of the directive provide documentation text, excluding parameter
documentation, which is provided by the schema.