aboutsummaryrefslogtreecommitdiffstats
path: root/lib/htmlpurifier/configdoc/styles/plain.xsl
blob: 9b9794e0bdad475ec9a6866dc4898bde7e46e913 (plain) (blame)
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
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet
    version     = "1.0"
    xmlns       = "http://www.w3.org/1999/xhtml"
    xmlns:xsl   = "http://www.w3.org/1999/XSL/Transform"
>
    <xsl:output
        method      = "xml"
        encoding    = "UTF-8"
        doctype-public = "-//W3C//DTD XHTML 1.0 Transitional//EN"
        doctype-system = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
        indent = "no"
        media-type = "text/html"
    />
    <xsl:param name="css" select="'styles/plain.css'"/>
    <xsl:param name="title" select="'Configuration Documentation'"/>

    <xsl:variable name="typeLookup"  select="document('../types.xml')/types" />
    <xsl:variable name="usageLookup" select="document('../usage.xml')/usage" />

    <!-- Twiddle this variable to get the columns as even as possible -->
    <xsl:variable name="maxNumberAdjust" select="2" />

    <xsl:template match="/">
        <html lang="en" xml:lang="en">
            <head>
                <title><xsl:value-of select="$title" /> - <xsl:value-of select="/configdoc/title" /></title>
                <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
                <link rel="stylesheet" type="text/css" href="{$css}" />
            </head>
            <body>
                <div id="content">
                    <div id="library"><xsl:value-of select="/configdoc/title" /></div>
                    <h1><xsl:value-of select="$title" /></h1>
                    <div id="tocContainer">
                        <h2>Table of Contents</h2>
                        <ul id="toc">
                            <xsl:apply-templates mode="toc">
                                <xsl:with-param name="overflowNumber" select="round(count(/configdoc/namespace) div 2) + $maxNumberAdjust" />
                            </xsl:apply-templates>
                        </ul>
                    </div>
                    <div id="typesContainer">
                        <h2>Types</h2>
                        <xsl:apply-templates select="$typeLookup" mode="types" />
                    </div>
                    <xsl:apply-templates />
                </div>
            </body>
        </html>
    </xsl:template>

    <xsl:template match="type" mode="types">
        <div class="type-block">
            <xsl:attribute name="id">type-<xsl:value-of select="@id" /></xsl:attribute>
            <h3><code><xsl:value-of select="@id" /></code>: <xsl:value-of select="@name" /></h3>
            <div class="type-description">
                <xsl:copy-of xmlns:xhtml="http://www.w3.org/1999/xhtml" select="xhtml:div/node()" />
            </div>
        </div>
    </xsl:template>

    <xsl:template match="title" mode="toc" />
    <xsl:template match="namespace" mode="toc">
        <xsl:param name="overflowNumber" />
        <xsl:variable name="number"><xsl:number level="single" /></xsl:variable>
        <xsl:variable name="directiveNumber"><xsl:number level="any" count="directive" /></xsl:variable>
        <xsl:if test="count(directive)&gt;0">
            <li>
                <!-- BEGIN multicolumn code -->
                <xsl:if test="$number &gt;= $overflowNumber">
                    <xsl:attribute name="class">col-2</xsl:attribute>
                </xsl:if>
                <xsl:if test="$number = $overflowNumber">
                    <xsl:attribute name="style">margin-top:-<xsl:value-of select="($number * 2 + $directiveNumber - 3) * 1.2" />em</xsl:attribute>
                </xsl:if>
                <!-- END multicolumn code -->
                <a href="#{@id}"><xsl:value-of select="name" /></a>
                <ul>
                    <xsl:apply-templates select="directive" mode="toc">
                        <xsl:with-param name="overflowNumber" select="$overflowNumber" />
                    </xsl:apply-templates>
                </ul>
                <xsl:if test="$number + 1 = $overflowNumber">
                    <div class="col-l" />
                </xsl:if>
            </li>
        </xsl:if>
    </xsl:template>
    <xsl:template match="directive" mode="toc">
        <xsl:variable name="number">
            <xsl:number level="any" count="directive|namespace" />
        </xsl:variable>
        <xsl:if test="not(deprecated)">
            <li>
                <a href="#{@id}"><xsl:value-of select="name" /></a>
            </li>
        </xsl:if>
    </xsl:template>

    <xsl:template match="title" />

    <xsl:template match="namespace">
        <div class="namespace">
            <xsl:apply-templates />
            <xsl:if test="count(directive)=0">
                <p>No configuration directives defined for this namespace.</p>
            </xsl:if>
        </div>
    </xsl:template>
    <xsl:template match="namespace/name">
        <h2 id="{../@id}"><xsl:value-of select="." /></h2>
    </xsl:template>
    <xsl:template match="namespace/description">
        <div class="description">
            <xsl:copy-of xmlns:xhtml="http://www.w3.org/1999/xhtml" select="xhtml:div/node()" />
        </div>
    </xsl:template>

    <xsl:template match="directive">
        <div>
            <xsl:attribute name="class"><!--
                -->directive<!--
                --><xsl:if test="deprecated"> deprecated</xsl:if><!--
            --></xsl:attribute>
            <xsl:apply-templates>
                <xsl:with-param name="id" select="@id" />
            </xsl:apply-templates>
        </div>
    </xsl:template>
    <xsl:template match="directive/name">
        <xsl:param name="id" />
        <xsl:apply-templates select="../aliases/alias" mode="anchor" />
        <h3 id="{$id}"><xsl:value-of select="$id" /></h3>
    </xsl:template>
    <xsl:template match="alias" mode="anchor">
        <a id="{.}"></a>
    </xsl:template>

    <!-- Do not pass through -->
    <xsl:template match="alias"></xsl:template>

    <xsl:template match="directive/constraints">
        <xsl:param name="id" />
        <table class="constraints">
            <xsl:apply-templates />
            <xsl:if test="../aliases/alias">
                <xsl:apply-templates select="../aliases" mode="constraints" />
            </xsl:if>
            <xsl:apply-templates select="$usageLookup/directive[@id=$id]" />
        </table>
    </xsl:template>
    <xsl:template match="directive/aliases" mode="constraints">
        <tr>
            <th>Aliases</th>
            <td>
                <xsl:for-each select="alias">
                    <xsl:if test="position()&gt;1">, </xsl:if>
                    <xsl:value-of select="." />
                </xsl:for-each>
            </td>
        </tr>
    </xsl:template>
    <xsl:template match="directive/description">
        <div class="description">
            <xsl:copy-of xmlns:xhtml="http://www.w3.org/1999/xhtml" select="xhtml:div/node()" />
        </div>
    </xsl:template>
    <xsl:template match="directive/deprecated">
        <div class="deprecated-notice">
            <strong>Warning:</strong>
            This directive was deprecated in version <xsl:value-of select="version" />.
            <a href="#{use}">%<xsl:value-of select="use" /></a> should be used instead.
        </div>
    </xsl:template>
    <xsl:template match="usage/directive">
        <tr>
            <th>Used in</th>
            <td>
                <ul>
                    <xsl:apply-templates />
                </ul>
            </td>
        </tr>
    </xsl:template>
    <xsl:template match="usage/directive/file">
        <li>
            <em><xsl:value-of select="@name" /></em> on line<xsl:if test="count(line)&gt;1">s</xsl:if>
            <xsl:text> </xsl:text>
            <xsl:for-each select="line">
                <xsl:if test="position()&gt;1">, </xsl:if>
                <xsl:value-of select="." />
            </xsl:for-each>
        </li>
    </xsl:template>

    <xsl:template match="constraints/version">
        <tr>
            <th>Version added</th>
            <td><xsl:value-of select="." /></td>
        </tr>
    </xsl:template>
    <xsl:template match="constraints/type">
        <tr>
            <th>Type</th>
            <td>
                <xsl:variable name="type" select="text()" />
                <xsl:attribute name="class">type type-<xsl:value-of select="$type" /></xsl:attribute>
                <a>
                    <xsl:attribute name="href">#type-<xsl:value-of select="$type" /></xsl:attribute>
                    <xsl:value-of select="$typeLookup/type[@id=$type]/@name" />
                    <xsl:if test="@allow-null='yes'">
                        (or null)
                    </xsl:if>
                </a>
            </td>
        </tr>
    </xsl:template>
    <xsl:template match="constraints/allowed">
        <tr>
            <th>Allowed values</th>
            <td>
                <xsl:for-each select="value"><!--
                 --><xsl:if test="position()&gt;1">, </xsl:if>
                    &quot;<xsl:value-of select="." />&quot;<!--
             --></xsl:for-each>
            </td>
        </tr>
    </xsl:template>
    <xsl:template match="constraints/default">
        <tr>
            <th>Default</th>
            <td><pre><xsl:value-of select="." xml:space="preserve" /></pre></td>
        </tr>
    </xsl:template>
    <xsl:template match="constraints/external">
        <tr>
            <th>External deps</th>
            <td>
                <ul>
                    <xsl:apply-templates />
                </ul>
            </td>
        </tr>
    </xsl:template>
    <xsl:template match="constraints/external/project">
        <li><xsl:value-of select="." /></li>
    </xsl:template>

</xsl:stylesheet>

<!-- vim: et sw=4 sts=4
-->