From bd73fc6cc17544d14b029c528cd70da73dd0a364 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@agendaless.com>
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/renderer.rst | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 docs/zcml/renderer.rst

(limited to 'docs/zcml/renderer.rst')

diff --git a/docs/zcml/renderer.rst b/docs/zcml/renderer.rst
new file mode 100644
index 000000000..1a3942ede
--- /dev/null
+++ b/docs/zcml/renderer.rst
@@ -0,0 +1,53 @@
+.. _renderer_directive:
+
+``renderer``
+------------
+
+The ``renderer`` ZCML directive can be used to override an existing
+existing :term:`renderer` or to add a new renderer.
+
+Attributes
+~~~~~~~~~~
+
+``factory``
+
+    A :term:`dotted Python name` referencing a callable object that
+    accepts a renderer name and returns a :term:`renderer` object.
+
+``name``
+
+   The renderer name, which is a string.
+
+Examples
+~~~~~~~~
+
+.. topic:: Registering a Non-Template Renderer
+
+   .. code-block:: xml
+      :linenos:
+
+      <renderer
+         factory="some.renderer"
+         name="mynewrenderer"
+         />
+
+.. topic:: Registering a Template Renderer
+
+   .. code-block:: xml
+      :linenos:
+
+      <renderer
+         factory="some.jinja2.renderer"
+         name=".jinja2"
+         />
+
+Alternatives
+~~~~~~~~~~~~
+
+The :meth:`repoze.bfg.configuration.Configurator.add_renderer` method
+is equivalent to the ``renderer`` ZCML directive.
+
+See Also
+~~~~~~~~
+
+See also :ref:`adding_and_overriding_renderers`.
-- 
cgit v1.2.3