From bd73fc6cc17544d14b029c528cd70da73dd0a364 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 17 Jan 2010 17:55:39 +0000 Subject: Using a single chapter for the API docs and a single chapter for the ZCML directives made it hard to read. --- docs/zcml/utility.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/zcml/utility.rst (limited to 'docs/zcml/utility.rst') diff --git a/docs/zcml/utility.rst b/docs/zcml/utility.rst new file mode 100644 index 000000000..88198eaa0 --- /dev/null +++ b/docs/zcml/utility.rst @@ -0,0 +1,50 @@ +.. _utility_directive: + +``utility`` +----------- + +Register a :term:`Zope Component Architecture` "utility". + +Attributes +~~~~~~~~~~ + +``component`` + + The utility component (cannot be specified if ``factory`` is + specified). + +``factory`` + + A factory that creates a component (cannot be specified if + ``component`` is specified). + +``provides`` + + The :term:`interface` that an utility instance resulting from a + lookup will provide. + +``name`` + + The utility name. + +Example +~~~~~~~ + +.. code-block:: xml + :linenos: + + + +Alternatives +~~~~~~~~~~~~ + +Use the ``registerUtility`` method of the ``registry`` attribute of a +:term:`Configurator` instance during initial application setup. + +See Also +~~~~~~~~ + +None. -- cgit v1.2.3