/
doc_schema.xsd
218 lines (186 loc) · 8.01 KB
/
doc_schema.xsd
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
<?xml version="1.0" encoding="utf-8"?>
<schema
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:d="urn:lighttpd.net:lighttpd2/doc1"
targetNamespace="urn:lighttpd.net:lighttpd2/doc1"
elementFormDefault="qualified">
<!-- root nodes -->
<element name="module" type="d:ModuleType" />
<element name="angel-module" type="d:AngelModuleType" />
<element name="chapter" type="d:ChapterType" />
<complexType name="ModuleType">
<sequence>
<!-- a module requires a short description -->
<element name="short" type="string" />
<!-- optional description to print below ToC -->
<element name="description" type="d:DescriptionType" minOccurs="0" />
<!-- a module cannot contain more simple text; include it in a section -->
<choice minOccurs="0" maxOccurs="unbounded">
<element name="action" type="d:ActionSetupType" />
<element name="setup" type="d:ActionSetupType" />
<element name="option" type="d:OptionType" />
<element name="example" type="d:ExampleType" />
<element name="section" type="d:ModuleSectionType" />
</choice>
</sequence>
<!-- optional title, defaults to module name, which is the basename -->
<attribute name="title" type="token" use="optional" />
<!-- order modules / chapters. defaults to name -->
<attribute name="order" type="Name" use="optional" />
</complexType>
<complexType name="ActionSetupParameterTypeParameterTableEntryType">
<sequence>
<element name="short" type="string" />
</sequence>
<attribute name="name" type="Name" use="required" />
</complexType>
<complexType name="ActionSetupParameterTypeParameterTableType">
<sequence>
<element name="entry" type="d:ActionSetupParameterTypeParameterTableEntryType" maxOccurs="unbounded" />
</sequence>
</complexType>
<complexType name="ActionSetupParameterType">
<choice>
<element name="short" type="string" />
<element name="table" type="d:ActionSetupParameterTypeParameterTableType" />
</choice>
<!-- a parameter requires a name -->
<attribute name="name" type="Name" use="required" />
</complexType>
<complexType name="ActionSetupType">
<sequence>
<element name="short" type="string" />
<element name="parameter" type="d:ActionSetupParameterType" minOccurs="0" maxOccurs="unbounded" />
<element name="description" type="d:DescriptionType" minOccurs="0" />
<element name="example" type="d:ExampleType" minOccurs="0" maxOccurs="unbounded" />
</sequence>
<attribute name="name" type="Name" use="required" />
</complexType>
<complexType name="OptionParameterType">
<!-- a parameter requires a name -->
<attribute name="name" type="Name" use="required" />
</complexType>
<complexType name="OptionDefaultType">
<choice>
<element name="text" type="string" />
<element name="value" type="string" />
</choice>
</complexType>
<complexType name="OptionType">
<sequence>
<element name="short" type="string" />
<!-- has exactly one parameter, defaults to name "value" -->
<element name="parameter" type="d:OptionParameterType" minOccurs="0" />
<element name="default" type="d:OptionDefaultType" />
<element name="description" type="d:DescriptionType" minOccurs="0" />
<element name="example" type="d:ExampleType" minOccurs="0" maxOccurs="unbounded" />
</sequence>
<attribute name="name" type="Name" use="required" />
</complexType>
<complexType name="DescriptionType">
<sequence>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="html" type="anyType" />
<element name="markdown" type="anyType" />
</choice>
</sequence>
</complexType>
<complexType name="ExampleType">
<sequence>
<element name="description" type="d:DescriptionType" minOccurs="0" />
<element name="config" type="string" />
</sequence>
<!-- title defaults to "Example" -->
<attribute name="title" type="token" use="optional" />
<!-- set anchor (id attribute of <h*> node); set to '#' to generate a unique anchor; if no anchor is set no ToC entry is created -->
<attribute name="anchor" type="token" use="optional" />
</complexType>
<complexType name="ModuleSectionType">
<sequence>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="action" type="d:ActionSetupType" />
<element name="setup" type="d:ActionSetupType" />
<element name="option" type="d:OptionType" />
<element name="html" type="anyType" />
<element name="markdown" type="anyType" />
<element name="example" type="d:ExampleType" />
<element name="section" type="d:ModuleSectionType" />
</choice>
</sequence>
<!-- a section requires a title -->
<attribute name="title" type="token" use="required" />
<!-- set anchor (id attribute of <h*> node); set to '#' to generate a unique anchor; if no anchor is set no ToC entry is created -->
<attribute name="anchor" type="token" use="optional" />
</complexType>
<complexType name="ChapterType">
<sequence>
<!-- optional description to print below ToC -->
<element name="description" type="d:DescriptionType" minOccurs="0" />
<!-- a chapter cannot contain more simple text; include it in a section -->
<choice minOccurs="0" maxOccurs="unbounded">
<element name="example" type="d:ExampleType" />
<element name="section" type="d:ChapterSectionType" />
</choice>
</sequence>
<!-- a chapter requires a title -->
<attribute name="title" type="token" use="required" />
<!-- order modules / chapters. defaults to name -->
<attribute name="order" type="Name" use="optional" />
</complexType>
<complexType name="ChapterSectionType">
<sequence>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="html" type="anyType" />
<element name="markdown" type="anyType" />
<element name="example" type="d:ExampleType" />
<element name="section" type="d:ChapterSectionType" />
</choice>
</sequence>
<!-- a section requires a title -->
<attribute name="title" type="token" use="required" />
<!-- set anchor (id attribute of <h*> node); set to '#' to generate a unique anchor; if no anchor is set no ToC entry is created -->
<attribute name="anchor" type="token" use="optional" />
</complexType>
<complexType name="AngelModuleType">
<sequence>
<!-- a module requires a short description (not yet, only have "angel_plugin_core") -->
<!-- <element name="short" type="string" /> -->
<!-- optional description to print below ToC -->
<element name="description" type="d:DescriptionType" minOccurs="0" />
<!-- a module cannot contain more simple text; include it in a section -->
<choice minOccurs="0" maxOccurs="unbounded">
<element name="item" type="d:AngelItemType" />
<element name="example" type="d:ExampleType" />
<element name="section" type="d:AngelModuleSectionType" />
</choice>
</sequence>
<!-- optional title, defaults to module name, which is the basename -->
<attribute name="title" type="token" use="optional" />
<!-- order modules / chapters. defaults to name -->
<attribute name="order" type="Name" use="optional" />
</complexType>
<complexType name="AngelItemType">
<sequence>
<element name="short" type="string" />
<element name="parameter" type="d:ActionSetupParameterType" minOccurs="0" maxOccurs="unbounded" />
<element name="description" type="d:DescriptionType" minOccurs="0" />
<element name="example" type="d:ExampleType" minOccurs="0" maxOccurs="unbounded" />
</sequence>
<attribute name="name" type="Name" use="required" />
</complexType>
<complexType name="AngelModuleSectionType">
<sequence>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="item" type="d:AngelItemType" />
<element name="html" type="anyType" />
<element name="markdown" type="anyType" />
<element name="example" type="d:ExampleType" />
<element name="section" type="d:AngelModuleSectionType" />
</choice>
</sequence>
<!-- a section requires a title -->
<attribute name="title" type="token" use="required" />
<!-- set anchor (id attribute of <h*> node); set to '#' to generate a unique anchor; if no anchor is set no ToC entry is created -->
<attribute name="anchor" type="token" use="optional" />
</complexType>
</schema>