blob: 20c0ed76acff12b6a9292d857b3574c9928f673f (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
.. _configure_directive:
``configure``
-------------
Because :term:`ZCML` is XML, and because XML requires a single root
tag for each document, every ZCML file used by :mod:`repoze.bfg` must
contain a ``configure`` container directive, which acts as the root
XML tag. It is a "container" directive because its only job is to
contain other directives.
Attributes
~~~~~~~~~~
``xmlns``
The default XML namespace used for subdirectives.
Example
~~~~~~~
.. code-block:: xml
:linenos:
<configure xmlns="http://namespaces.repoze.org/bfg">
<!-- other directives -->
</configure>
.. _word_on_xml_namespaces:
A Word On XML Namespaces
~~~~~~~~~~~~~~~~~~~~~~~~
Usually, the start tag of the ``<configure>`` container tag has a
default *XML namespace* associated with it. This is usually
``http://namespaces.repoze.org/bfg``, named by the ``xmlns`` attribute
of the ``configure`` start tag.
Using the ``http://namespaces.repoze.org/bfg`` namespace as the
default XML namespace isn't strictly necessary; you can use a
different default namespace as the default. However, if you do, the
declaration tags which are defined by :mod:`repoze.bfg` such as the
``view`` declaration tag will need to be defined in such a way that
the XML parser that :mod:`repoze.bfg` uses knows which namespace the
:mod:`repoze.bfg` tags are associated with. For example, the
following files are all completely equivalent:
.. topic:: Use of A Non-Default XML Namespace
.. code-block:: xml
:linenos:
<configure xmlns="http://namespaces.zope.org/zope"
xmlns:bfg="http://namespaces.repoze.org/bfg">
<include package="repoze.bfg.includes" />
<bfg:view
view="helloworld.hello_world"
/>
</configure>
.. topic:: Use of A Per-Tag XML Namespace Without A Default XML Namespace
.. code-block:: xml
:linenos:
<configure>
<include package="repoze.bfg.includes" />
<view xmlns="http://namespaces.repoze.org/bfg"
view="helloworld.hello_world"
/>
</configure>
For more information about XML namespaces, see `this older, but simple
XML.com article <http://www.xml.com/pub/a/1999/01/namespaces.html>`_.
The conventions in this document assume that the default XML namespace
is ``http://namespaces.repoze.org/bfg``.
Alternatives
~~~~~~~~~~~~
None.
See Also
~~~~~~~~
See also :ref:`helloworld_declarative`.
|
