summaryrefslogtreecommitdiff
path: root/templates/reST.xsl
blob: 84fe00688304a04acf2b94ae259183cbd0b3c85f (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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
<!--
 Copyright (c) 2006, Michael Alyn Miller <malyn@strangeGizmo.com>.
 All rights reserved.
 
         Modified by Gianni Ceccarelli <dakkar@thenautilus.net>
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
 1.  Redistributions of source code must retain the above copyright
 notice unmodified, this list of conditions, and the following
 disclaimer.
 2.  Redistributions in binary form must reproduce the above
 copyright notice, this list of conditions and the following
 disclaimer in the documentation and/or other materials provided
 with the distribution.
 3.  Neither the name of Michael Alyn Miller nor the names of the
 contributors to this software may be used to endorse or promote
 products derived from this software without specific prior
 written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.
-->
 
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        xmlns:e="http://exslt.org/common"
        xmlns:s="http://exslt.org/strings"
xmlns="http://www.w3.org/1999/xhtml"
        exclude-result-prefixes="e s"
        >
 
 
<xsl:template match="@classes">
 <xsl:param name="add" select="/.."/>
 <xsl:if test=".|$add">
  <xsl:attribute name="class"><xsl:value-of select="."/> <xsl:value-of select="$add"/></xsl:attribute>
 </xsl:if>
</xsl:template> 
 
<!-- Suppress the reST document title and information.
 These values should be pulled in by the main XSL template. -->
<xsl:template match="/document/title" />
<xsl:template match="/document/docinfo" />
 
<!-- Suppress all field lists.  These are only used for 'special
 features' implemented by the author of the site-specific reST
 content. -->
<xsl:template match="field_list" />
<xsl:template match="comment" />
 
 
<!-- ===================================================================
 Inline elements.
 -->
 
<xsl:template match="emphasis">
<em><xsl:apply-templates /></em>
</xsl:template>
 
<xsl:template match="literal">
<tt class="docutils literal"><span class="pre"><xsl:apply-templates /></span></tt>
</xsl:template>
 
<xsl:template match="title_reference">
 <cite><xsl:apply-templates/></cite>
</xsl:template>
 
<xsl:template match="superscript">
 <sup><xsl:apply-templates/></sup>
</xsl:template>
 
<xsl:template match="subscript">
 <sub><xsl:apply-templates/></sub>
</xsl:template>
 
<xsl:template match="reference">
<xsl:element name="a">
<xsl:attribute name="href">
<xsl:choose>
<xsl:when test="@refid">
<xsl:value-of select="concat('#', @refid)" />
</xsl:when>
<xsl:when test="@refuri">
<xsl:value-of select="@refuri" />
</xsl:when>
</xsl:choose>
</xsl:attribute>
 
<xsl:apply-templates />
</xsl:element>
</xsl:template>
 
<xsl:template match="strong">
<strong><xsl:apply-templates /></strong>
</xsl:template>
 
 
 
<!-- ===================================================================
 Body elements.
 -->
 
 
<!-- Generic body elements. -->
<xsl:template match="image">
<xsl:element name="img">
<xsl:attribute name="src">
<xsl:value-of select="@uri" />
</xsl:attribute>
<xsl:attribute name="alt">
<xsl:value-of select="@alt" />
</xsl:attribute>
<xsl:attribute name="width">
<xsl:value-of select="@width" />
</xsl:attribute>
<xsl:attribute name="height">
<xsl:value-of select="@height" />
</xsl:attribute>
</xsl:element>
</xsl:template>
 
<xsl:template match="figure">
 <div class="figure {@classes}">
  <xsl:apply-templates />
 </div>
</xsl:template>
 
<xsl:template match="caption">
 <div class="caption {@classes}">
  <xsl:apply-templates />
 </div>
</xsl:template>
 
<xsl:template match="line_block">
<div class="line-block {@classes}">
<xsl:apply-templates />
</div>
</xsl:template>
 
<xsl:template match="line_block/line">
 <div class="line"><xsl:apply-templates /></div>
</xsl:template>
 
 
<xsl:template match="literal_block">
<pre class="literal-block {@classes}"><xsl:apply-templates /></pre>
</xsl:template>
 
<xsl:template match="literal_block/br">
<br />
</xsl:template>
 
<xsl:template match="doctest_block">
<pre class="doctest-block {@classes}"><xsl:apply-templates /></pre>
</xsl:template>
 
 
<xsl:template match="paragraph">
<p><xsl:apply-templates select="@classes"/><xsl:apply-templates /></p>
</xsl:template>
 
<xsl:template match="substitution_definition" />
 
 
 
<!-- reST block quotes get prepended with a paragraph that reads
 "ATTRIBUTION wrote:" where ATTRIBUTION is the contents of the
 reStructuredText attribution (the information after the
 double-hyphens). -->
<xsl:template match="block_quote">
<blockquote>
         <xsl:apply-templates select="@classes"/>
<xsl:apply-templates/>
</blockquote>
</xsl:template>
 
<xsl:template match="block_quote/attribution" >
 <p class="attribution {@classes}">
  <xsl:text>— </xsl:text>
  <xsl:apply-templates />
 </p>
</xsl:template>
 
<!-- Footnote references are wrapped in brackets ([..]) and enclosed in
 an anchor tag with the class "footnoteref". -->
<xsl:template match="footnote_reference">
 <a class="footnote-reference" id="{@ids}" href="#{@refid}">
  <xsl:text>[</xsl:text>
  <xsl:apply-templates />
  <xsl:text>]</xsl:text>
 </a>
</xsl:template>
 
<!-- The footnote itself is wrapped in a div tag with a class of
 "footnote".  The footnote begins with an anchor tag (class name
 "footnotereturn") that links back to the part of the document where
 the footnote appeared. -->
<xsl:template match="footnote">
 <xsl:variable name="label" select="label"/>
 <xsl:variable name="backrefs" select="s:split(@backrefs,' ')/token"/>
 <div class="footnote {@classes}" id="{@ids}">
  <xsl:choose>
   <xsl:when test="count($backrefs) &lt;= 1">
    <span class="label"><a class="fn-backref" href="#{$backrefs}">[<xsl:value-of select="$label"/>]</a></span>
   </xsl:when>
   <xsl:otherwise>
    <span class="label">[<xsl:value-of select="$label"/>]</span>
    <em><xsl:text> (</xsl:text>
    <xsl:for-each select="$backrefs">
     <a class="fn-backref" href="#{.}" title="return to content">
      <xsl:value-of select="position()" />
     </a>
     <xsl:if test="following-sibling::token"></xsl:if>
    </xsl:for-each>
    <xsl:text>)</xsl:text></em>
   </xsl:otherwise>
  </xsl:choose>
  <xsl:text> </xsl:text>
  <xsl:apply-templates />
 </div>
</xsl:template>
<xsl:template match="footnote/label" />
 
 
<!-- Basic lists. -->
<xsl:template name="list-class">
 <xsl:attribute name="class">
  <xsl:value-of select="@enumtype"/>
  <xsl:value-of select="@classes"/>
 </xsl:attribute>
</xsl:template>
 
<xsl:template match="bullet_list">
<ul>
         <xsl:call-template name="list-class"/>
         <xsl:apply-templates />
        </ul>
</xsl:template>
 
<xsl:template match="enumerated_list">
<ol>
         <xsl:call-template name="list-class"/>
         <xsl:if test="@start">
          <xsl:attribute name="start"><xsl:value-of select="@start"/></xsl:attribute>
         </xsl:if>
         <xsl:apply-templates />
        </ol>
</xsl:template>
 
<!-- Basic list items. -->
<xsl:template match="list_item">
<li><xsl:apply-templates select="@classes"/><xsl:apply-templates /></li>
</xsl:template>
 
<!-- TODO Lists are currently stripped of their paragraph wrapping.
This may or may not be what you want.  You could use a match value
of "list_item/paragraph[count(child::*) = 0]" to detect simple vs.
complex paragraphs, although this would also catch inline elements.
A stunningly-complex match value should probably be created to
detect the list type (simple or complex) and then put all of the
items into the same wrapper (either a p tag or a bare list item). -->
<xsl:template match="list_item/paragraph">
<xsl:apply-templates />
</xsl:template>
 
 
<!-- Definition lists. -->
<xsl:template match="definition_list">
<dl><xsl:apply-templates select="@classes"/><xsl:apply-templates /></dl>
</xsl:template>
 
<xsl:template match="definition_list_item">
 <xsl:apply-templates select="term|definition"/>
</xsl:template>
 
<xsl:template match="definition_list_item/term">
<dt><xsl:apply-templates select="@classes"/><xsl:apply-templates />  <xsl:apply-templates select="../classifier"/></dt>
</xsl:template>
 
<xsl:template match="definition_list_item/definition">
<dd><xsl:apply-templates select="@classes"/><xsl:apply-templates /></dd>
</xsl:template>
 
<xsl:template match="definition_list_item/classifier">
 <span class="classifier-delimiter">:</span>
 <xsl:text> </xsl:text>
 <span class="classifier"><xsl:apply-templates/></span>
</xsl:template>
 
<!-- Option lists. -->
<xsl:template match="option_list">
<table class="docutils option-list {@classes}" cellpadding="0" cellspacing="0">
         <col class="option" /><col class="description" />
         <xsl:apply-templates />
</table>
</xsl:template>
 
<xsl:template match="option_list_item">
<tr><xsl:apply-templates /></tr>
</xsl:template>
 
<xsl:template match="option_group">
<td class="option-group {@classes}">
<xsl:for-each select="option">
                 <xsl:apply-templates select="." />
                 <xsl:if test="following-sibling::option"></xsl:if>
</xsl:for-each>
</td>
</xsl:template>
 
<xsl:template match="option_group/option">
 <kbd><span class="option"><xsl:value-of select="option_string" /></span>
<xsl:if test="option_argument">
<span class="option-delimiter"><xsl:value-of select="option_argument/@delimiter" /></span>
                <var><span class="option-argument"><xsl:value-of select="option_argument" /></span></var>
</xsl:if>
 </kbd>
</xsl:template>
 
<xsl:template match="option_list_item/description">
<td><xsl:apply-templates /></td>
</xsl:template>
 
 
<!-- Raw HTML elements are passed straight through.  Note that this
 assumes that the output document is an XHTML document. -->
<xsl:template match="raw[@format='html']">
<xsl:value-of select="." disable-output-escaping="yes" />
</xsl:template>
 
 
<!-- Section titles are wrapped in a heading tag.  The heading level
 (h1, h2, h3, etc.) is set by counting the number of parent sections
 that this section is enclosed in. -->
<xsl:template match="section/title">
<xsl:element name="{concat('h', format-number(count(ancestor::section), '#'))}">
<xsl:attribute name="id">
<xsl:value-of select="parent::section/@ids" />
</xsl:attribute>
 
<xsl:apply-templates />
</xsl:element>
</xsl:template>
 
<xsl:template match="title" priority="-1">
 <h1 class="{@classes}">
  <xsl:apply-templates/>
 </h1>
</xsl:template>
 
<xsl:template match="subtitle" priority="-1">
 <h2 class="{@classes}">
  <xsl:apply-templates/>
 </h2>
</xsl:template>
 
<!-- admonitions -->
 
<xsl:template match="attention|caution|danger|error|hint|important|note|tip|warning">
 <div class="{local-name()} {@classes}">
  <p class="admonition-title"><xsl:apply-templates select="." mode="admonition-title"/></p>
  <xsl:apply-templates/>
 </div>
</xsl:template>
 
<xsl:template match="*" mode="admonition-title"><!-- to be overridden -->
 <xsl:value-of select="local-name()"/>
</xsl:template>
 
<xsl:template match="admonition">
 <div class="admonition {@classes}">
  <xsl:apply-templates/>
 </div>
</xsl:template>
 
<xsl:template match="admonition/title">
 <p class="admonition-title"><xsl:apply-templates/></p>
</xsl:template>
 
<!-- other directives -->
 
<xsl:template match="topic|sidebar">
 <div class="{local-name()} {@classes}">
  <xsl:if test="@ids">
   <xsl:attribute name="id"><xsl:value-of select="@ids"/></xsl:attribute>
   <a name="{@ids}" />
  </xsl:if>
  <xsl:apply-templates />
 </div>
</xsl:template>
 
<xsl:template match="sidebar/title|sidebar/subtitle|topic/title|topic/subtitle">
 <p class="{local-name(parent::*)}-{local-name()} {@classes}">
  <xsl:apply-templates/>
 </p>
</xsl:template>
 
<xsl:template match="rubric">
 <p class="rubric {@classes}"><xsl:apply-templates/></p>
</xsl:template>
 
<!-- Tables.
 
 These are pretty much handled as you would expect.  The only custom
 feature is a pair of special fields that can be used to control the
 horizontal and vertical alignment of the table cells.
 
 If you want to set a custom horizontal alignment, include the field
 ":table-cell-halign:" directly before the table.  Each of the cells
 (td elements) will include an "align" attribute with the specified
 value.
 
 A similar field exists for specifying the valign value.  This field
 is called ":table-cell-valign:".  -->
<xsl:template match="table">
<table class="docutils {@classes}" border="1">
         <xsl:apply-templates />
        </table>
</xsl:template>
 
<xsl:template match="thead">
<thead><xsl:apply-templates /></thead>
</xsl:template>
 
<xsl:template match="thead/row">
<tr><xsl:apply-templates /></tr>
</xsl:template>
 
<xsl:template match="thead/row/entry">
<xsl:element name="th">
<xsl:if test="@morecols">
<xsl:attribute name="colspan">
<xsl:value-of select="format-number(1 + @morecols, '#')" />
</xsl:attribute>
</xsl:if>
<xsl:if test="@morerows">
<xsl:attribute name="rowspan">
<xsl:value-of select="format-number(1 + @morerows, '#')" />
</xsl:attribute>
</xsl:if>
 
<xsl:apply-templates />
</xsl:element>
</xsl:template>
 
<xsl:template match="tbody">
<tbody><xsl:apply-templates /></tbody>
</xsl:template>
 
<xsl:template match="tbody/row">
<tr><xsl:apply-templates /></tr>
</xsl:template>
 
<xsl:template match="tbody/row/entry">
<xsl:element name="td">
<xsl:if test="@morecols">
<xsl:attribute name="colspan">
<xsl:value-of select="format-number(1 + @morecols, '#')" />
</xsl:attribute>
</xsl:if>
<xsl:if test="@morerows">
<xsl:attribute name="rowspan">
<xsl:value-of select="format-number(1 + @morerows, '#')" />
</xsl:attribute>
</xsl:if>
        <xsl:if test="ancestor::table/preceding-sibling::*[1]/field/field_name[text()='table-cell-halign']">
<xsl:attribute name="align">
                <xsl:value-of select="ancestor::table/preceding-sibling::*[1]/field/field_name[text()='table-cell-halign']/../field_body/paragraph" />
</xsl:attribute>
        </xsl:if>
        <xsl:if test="ancestor::table/preceding-sibling::*[1]/field/field_name[text()='table-cell-valign']">
<xsl:attribute name="valign">
                <xsl:value-of select="ancestor::table/preceding-sibling::*[1]/field/field_name[text()='table-cell-valign']/../field_body/paragraph" />
</xsl:attribute>
        </xsl:if>
 
<xsl:apply-templates />
</xsl:element>
</xsl:template>
 
<xsl:template match="transition">
 <hr />
</xsl:template>
 
</xsl:stylesheet>