summaryrefslogtreecommitdiffstats
path: root/schemas/genshi.xsd
blob: 4183045111a92c5708f4e29d60e4e941d10fc84d (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:py="http://genshi.edgewall.org/"
           xml:lang="en"
           targetNamespace="http://genshi.edgewall.org/"
           elementFormDefault="qualified">
  <xs:annotation>
    <xs:documentation>
      Genshi XML templating language schema
    </xs:documentation>
  </xs:annotation>

  <!-- genshi types -->
  <xs:complexType name="forType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `for directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id3&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
    <xs:attribute name="each" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
          The loop iterator
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="ifType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `if directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id1&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
    <xs:attribute name="test" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
          The statement giving the value to test
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="matchType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `match directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id5&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
    <xs:attribute name="path" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
          XPath expression to search for in the template.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="once" type="xs:boolean" default="false">
      <xs:annotation>
        <xs:documentation>
          Whether the engine should stop looking for more matching
          elements after the first match. Use this on match templates
          that match elements that can only occur once in the stream,
          such as the &lt;head&gt; or &lt;body&gt; elements in an HTML
          template, or elements with a specific ID.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="buffer" type="xs:boolean" default="true">
      <xs:annotation>
        <xs:documentation>
          Whether the matched content should be buffered in
          memory. Buffering can improve performance a bit at the cost
          of needing more memory during rendering. Buffering is
          *required* for match templates that contain more than one
          invocation of the ``select()`` function. If there is only
          one call, and the matched content can potentially be very
          long, consider disabling buffering to avoid excessive memory
          use.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="recursive" type="xs:boolean" default="true">
      <xs:annotation>
        <xs:documentation>
          Whether the match template should be applied to its own
          output. Note that once implies non-recursive behavior, so
          this attribute only needs to be set for match templates that
          don't also have once set.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="defType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `def directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id4&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
    <xs:attribute name="function" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
          The function prototype
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="withType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `with directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#py-with&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
    <xs:attribute name="vars" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
          A semicolon-delimited list of variables to define and their
          values.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="replaceType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `replace directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id8&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
    <xs:attribute name="value" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
          The value to replace the contents with.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="chooseType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        `choose directive
        &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id2&gt;`_
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="when" type="py:ifType" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>
            The ``when`` directive is used inside
            :xml:type:`py:chooseType` or
            :xml:attribute:`py:genshiAttrs:choose` to handle a single
            specific condition.
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="otherwise" type="py:otherwiseType"
                  minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="test" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          If ``test`` is set, the child :xml:element:`py:when`
          directives are tested for equality to the value of the
          expression.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>

  <xs:complexType name="otherwiseType" mixed="true">
    <xs:annotation>
      <xs:documentation>
        The ``otherwise`` directive is used inside
        :xml:type:`py:chooseType` or
        :xml:attribute:`py:genshiAttrs:choose` to handle all
        conditions not handled by a :xml:element:`py:when`.
      </xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:any processContents="lax"/>
    </xs:choice>
  </xs:complexType>

  <!-- genshi tags -->
  <xs:group name="genshiElements">
    <xs:annotation>
      <xs:documentation>
        Most Genshi templating directives can be used either as
        standalone elements or as attributes on existing elements.
        This element group defines the standalone tags.
      </xs:documentation>
    </xs:annotation>
    <xs:choice>
      <xs:element name="with" type="py:withType"/>
      <xs:element name="replace" type="py:replaceType"/>
      <xs:element name="choose" type="py:chooseType"/>
      <xs:element name="for" type="py:forType"/>
      <xs:element name="if" type="py:ifType"/>
      <xs:element name="match" type="py:matchType"/>
      <xs:element name="def" type="py:defType"/>
    </xs:choice>
  </xs:group>

  <!-- genshi attributes -->
  <xs:attributeGroup name="genshiAttrs">
    <xs:annotation>
      <xs:documentation>
        Most Genshi templating directives can be used either as
        standalone elements or as attributes on existing elements.
        This attribute group defines the attribute directives.
      </xs:documentation>
    </xs:annotation>
    <xs:attribute name="if" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `if directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id1&gt;`_

        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="choose" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `choose directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id2&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="when" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          The ``when`` directive is used inside
          :xml:type:`py:chooseType` or
          :xml:attribute:`py:genshiAttrs:choose` to handle a single
          specific condition.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="otherwise" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          The ``otherwise`` directive is used inside
          :xml:type:`py:chooseType` or
          :xml:attribute:`py:genshiAttrs:choose` to handle all
          conditions not handled by a :xml:element:`py:when`.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="for" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `for directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id3&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="def" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `def directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id4&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="match" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `match directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id5&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="with" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `with directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#py-with&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="attrs" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `attrs directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id6&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="content" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `content directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id7&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="replace" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `replace directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id8&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="strip" type="xs:string" form="qualified">
      <xs:annotation>
        <xs:documentation>
          `strip directive
          &lt;http://genshi.edgewall.org/wiki/Documentation/xml-templates.html#id9&gt;`_
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:attributeGroup>
</xs:schema>