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/adapter.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/zcml/adapter.rst (limited to 'docs/zcml/adapter.rst') diff --git a/docs/zcml/adapter.rst b/docs/zcml/adapter.rst new file mode 100644 index 000000000..48ed49f6c --- /dev/null +++ b/docs/zcml/adapter.rst @@ -0,0 +1,51 @@ +.. _adapter_directive: + +``adapter`` +----------- + +Register a :term:`Zope Component Architecture` "adapter". + +Attributes +~~~~~~~~~~ + +``factory`` + + The adapter factory (often a class). + +``provides`` + + The :term:`interface` that an adapter instance resulting from a + lookup will provide. + +``for`` + + Interfaces or classes to be adapted, separated by spaces, + e.g. ``interfaces.IFoo interfaces.IBar``. + +``name`` + + The adapter name. + +Example +~~~~~~~ + +.. code-block:: xml + :linenos: + + + +Alternatives +~~~~~~~~~~~~ + +Use the ``registerAdapter`` method of the ``registry`` attribute of a +:term:`Configurator` instance during initial application setup. + +See Also +~~~~~~~~ + +None. + -- cgit v1.2.3