summaryrefslogtreecommitdiff
path: root/docs/zcml/renderer.rst
blob: 1a3942edea6d4b30c3636ad7b6057db85254ef39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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`.