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
|
<?xml version="1.0"?>
<xsl:stylesheet
xmlns="http://www.w3.org/1999/xhtml"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:rng="http://relaxng.org/ns/structure/1.0"
xmlns:a="http://ns.wildfiregames.com/entity"
exclude-result-prefixes="rng a"
version="1.0">
<xsl:output method="xml" encoding="utf-8" omit-xml-declaration="yes" indent="yes"/>
<xsl:key name="defname" match="rng:define" use="@name"/>
<xsl:template match="/">
<xsl:text disable-output-escaping="yes"><!DOCTYPE html> </xsl:text>
<html>
<head>
<meta charset="utf-8"/>
<title>0 A.D. entity XML documentation</title>
<link rel="stylesheet" href="entity-docs.css"/>
</head>
<body>
<h1>Entity component documentation</h1>
<p>
In <a href="http://play0ad.com/">0 A.D.</a>,
entities (units and buildings and other world objects)
consist of a collection of components, each of which determines
part of the entity's behaviour.
Entity template XML files specify the list of components that are loaded for
each entity type, plus initialisation data for the components.
</p>
<p>
This page lists the components that can be added to entities
and the XML syntax for their initialisation data.
</p>
<p>
Available components:
</p>
<xsl:apply-templates mode="components-toc"/>
<input type="checkbox" id="show-grammar"/> <i>Display RELAX NG grammar fragments</i>
<xsl:apply-templates mode="components"/>
</body>
</html>
</xsl:template>
<!-- List all the interfaces in alphabetic order -->
<xsl:template match="rng:grammar" mode="components-toc">
<ul>
<xsl:apply-templates select="rng:define[starts-with(@name, 'interface.')]" mode="components-toc">
<xsl:sort select="@name"/>
</xsl:apply-templates>
</ul>
</xsl:template>
<xsl:template match="rng:define" mode="components-toc">
<xsl:choose>
<xsl:when test="count(rng:choice/rng:ref[not(key('defname', @name)//a:component/@type)]) <= 1">
<xsl:apply-templates mode="components-toc"/>
</xsl:when>
<xsl:otherwise> <!-- multiple implementations of the same interface: -->
<li>
<xsl:value-of select="substring-after(@name, 'interface.')"/>
<ul>
<xsl:apply-templates mode="components-toc"/>
</ul>
</li>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- List components that are not special types -->
<xsl:template match="rng:ref[not(key('defname', @name)//a:component/@type)]" mode="components-toc">
<li>
<a>
<xsl:attribute name="href">
<xsl:text>#component.</xsl:text>
<xsl:value-of select="substring-after(@name, 'component.')"/>
</xsl:attribute>
<xsl:value-of select="substring-after(@name, 'component.')"/>
</a>
<xsl:value-of select="key('defname', @name)//a:component/@type"/>
</li>
</xsl:template>
<!-- List all the components in alphabetic order, excluding ones that are special types -->
<xsl:template match="rng:grammar" mode="components">
<xsl:apply-templates select="rng:define[starts-with(@name, 'component.') and not(key('defname', @name)//a:component/@type)]" mode="components">
<xsl:sort select="@name"/>
</xsl:apply-templates>
</xsl:template>
<!-- Component definition -->
<xsl:template match="rng:define" mode="components">
<xsl:variable name="name" select="substring-after(@name, 'component.')"/>
<section>
<xsl:attribute name="id"><xsl:value-of select="@name"/></xsl:attribute>
<h2><xsl:value-of select="$name"/></h2>
<xsl:if test=".//a:help">
<p><xsl:value-of select=".//a:help"/></p>
</xsl:if>
<xsl:if test="count(.//a:example) = 1"><h3>Example</h3></xsl:if>
<xsl:if test="count(.//a:example) > 1"><h3>Examples</h3></xsl:if>
<xsl:for-each select=".//a:example">
<xsl:call-template name="example">
<xsl:with-param name="name" select="$name"/>
</xsl:call-template>
</xsl:for-each>
<xsl:apply-templates mode="components"/>
<div class="grammar-box">
<h3>RELAX NG Grammar</h3>
<pre class="grammar">
<xsl:apply-templates mode="literal"/>
</pre>
</div>
</section>
</xsl:template>
<!-- Component XML example -->
<xsl:template match="*" name="example">
<xsl:param name="name"/>
<pre class="example">
<xsl:choose>
<xsl:when test="count(*) = 0">
<xsl:text><</xsl:text>
<span class="n"><xsl:value-of select="$name"/></span>
<xsl:text>/> </xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:text><</xsl:text>
<span class="n"><xsl:value-of select="$name"/></span>
<xsl:text>> </xsl:text>
<xsl:apply-templates select="*" mode="literal">
<xsl:with-param name="depth" select="1"/>
</xsl:apply-templates>
<xsl:text></</xsl:text>
<span class="n"><xsl:value-of select="$name"/></span>
<xsl:text>> </xsl:text>
</xsl:otherwise>
</xsl:choose>
</pre>
</xsl:template>
<!-- List each of the component's elements -->
<xsl:template match="rng:element" mode="components">
<xsl:apply-templates mode="component"/>
</xsl:template>
<!-- Component element description -->
<xsl:template match="rng:element[@name]" mode="component">
<h3><code><xsl:value-of select="@name"/></code></h3>
<xsl:if test="parent::rng:optional">
<p><em>Optional.</em></p>
</xsl:if>
<xsl:if test="@a:help">
<p><xsl:value-of select="@a:help"/>.</p>
</xsl:if>
<xsl:apply-templates mode="datatype"/>
<xsl:apply-templates mode="component"/>
</xsl:template>
<xsl:template match="rng:attribute" mode="component">
<h3><code><xsl:value-of select="@name"/></code></h3>
<xsl:if test="@a:help">
<p><xsl:value-of select="@a:help"/>.</p>
</xsl:if>
<xsl:apply-templates mode="datatype"/>
</xsl:template>
<xsl:template match="text()" mode="component"/> <!-- ignore text inside the grammar -->
<!-- Datatype description when all children are <value> -->
<xsl:template match="rng:choice[count(./*[not(local-name() = 'value')]) = 0]" mode="datatype">
<p><em>Value is one of:</em></p>
<dl>
<xsl:apply-templates mode="choice-values"/>
</dl>
</xsl:template>
<xsl:template match="rng:value" mode="choice-values">
<dt><code><xsl:value-of select="text()"/></code></dt>
<xsl:if test="@a:help">
<dd><xsl:value-of select="@a:help"/>.</dd>
</xsl:if>
</xsl:template>
<!-- Datatype description for fixed string -->
<xsl:template match="rng:value" mode="datatype">
<p><em>Required value:</em>
<xsl:text> </xsl:text>
<code><xsl:value-of select="text()"/></code></p>
</xsl:template>
<!-- Datatype description for text -->
<xsl:template match="rng:text" mode="datatype">
<p><em>Value type:</em> text.</p>
</xsl:template>
<!-- Datatype description for <data> -->
<xsl:template match="rng:data[@type]" mode="datatype">
<p><em>Value type:</em>
<xsl:text> </xsl:text>
<xsl:apply-templates select="@type" mode="datatype-name"/>.</p>
</xsl:template>
<!-- Datatype description for <ref> -->
<xsl:template match="rng:ref" mode="datatype">
<p><em>Value type:</em>
<xsl:text> </xsl:text>
<xsl:apply-templates select="@name" mode="datatype-name"/>.</p>
</xsl:template>
<xsl:template match="*" mode="datatype"/> <!-- don't recurse -->
<!-- Datatype names -->
<xsl:template match="@*" mode="datatype-name">
<xsl:choose>
<xsl:when test=". = 'nonNegativeDecimal'">non-negative decimal (e.g. <code>0.0</code> or <code>2.5</code>)</xsl:when>
<xsl:when test=". = 'positiveDecimal'">positive decimal (e.g. <code>1.0</code> or <code>2.5</code>)</xsl:when>
<xsl:when test=". = 'decimal'">decimal (e.g. <code>-10.0</code> or <code>0.0</code> or <code>2.5</code>)</xsl:when>
<xsl:when test=". = 'nonNegativeInteger'">non-negative integer (e.g. <code>0</code> or <code>5</code>)</xsl:when>
<xsl:when test=". = 'positiveInteger'">positive integer (e.g. <code>1</code> or <code>5</code>)</xsl:when>
<xsl:when test=". = 'boolean'">boolean (<code>true</code> or <code>false</code>)</xsl:when>
<xsl:otherwise><xsl:value-of select="."/></xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- Templates to output the input grammar as a pretty-printed string: -->
<xsl:template match="node()" mode="literal">
<xsl:param name="depth">0</xsl:param>
<xsl:call-template name="indent"><xsl:with-param name="depth" select="$depth"/></xsl:call-template>
<xsl:text><</xsl:text>
<span class="n"><xsl:value-of select="name()"/></span>
<xsl:apply-templates select="@*" mode="literal"/>
<xsl:if test="count(*|text()) = 0">
<xsl:text>/> </xsl:text>
</xsl:if>
<xsl:if test="count(*|text()) > 0">
<xsl:text>></xsl:text>
<xsl:if test="count(*) > 0">
<xsl:text> </xsl:text>
</xsl:if>
<xsl:apply-templates select="node()" mode="literal">
<xsl:with-param name="depth" select="$depth + 1"/>
</xsl:apply-templates>
<xsl:if test="count(*) > 0">
<xsl:call-template name="indent"><xsl:with-param name="depth" select="$depth"/></xsl:call-template>
</xsl:if>
<xsl:text></</xsl:text>
<span class="n"><xsl:value-of select="name()"/></span>
<xsl:text>> </xsl:text>
</xsl:if>
</xsl:template>
<xsl:template match="@*" mode="literal">
<xsl:text> </xsl:text>
<span class="n"><xsl:value-of select="name()"/></span>
<xsl:text>="</xsl:text>
<xsl:value-of select="."/>
<xsl:text>"</xsl:text>
</xsl:template>
<xsl:template match="a:*|@a:*" mode="literal"/>
<xsl:template match="text()" mode="literal">
<xsl:value-of select="."/>
</xsl:template>
<xsl:template name="indent">
<xsl:param name="depth"/>
<xsl:if test="$depth > 0">
<xsl:text> </xsl:text>
<xsl:call-template name="indent">
<xsl:with-param name="depth" select="$depth - 1"/>
</xsl:call-template>
</xsl:if>
</xsl:template>
</xsl:stylesheet>
|
