summaryrefslogtreecommitdiff
path: root/docs/manual/style/common.xsl
blob: 8f201dcaaa2906e4590e303f67612697c7650acb (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
<?xml version="1.0"?>
<!DOCTYPE xsl:stylesheet [ <!ENTITY nbsp "&#160;"> ]>
<xsl:stylesheet version="1.0"
              xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                  xmlns="http://www.w3.org/TR/xhtml1/strict">

  <!--                                                          -->
  <!-- Please, don't hard-code output strings! Use the language -->
  <!-- files and the translation "stuff"...                     -->
  <!--                                                          -->

 <!-- Constants used for case translation -->
 <xsl:variable name="lowercase" select="'abcdefghijklmnopqrstuvwxyz'" />
 <xsl:variable name="uppercase" select="'ABCDEFGHIJKLMNOPQRSTUVWXYZ'" />

 <!-- Defined parameters (overrideable) -->
 <xsl:param name="relative-path" select="'.'"/>

  <!--                              -->
  <!-- Builds the moduleindex page  -->
  <!--                              -->
  <xsl:template match="moduleindex">
    <html>
      <head>
        <title>
          <xsl:value-of select="title"/><xsl:value-of select="$messages/message[@name='apachetitle']"/>
        </title>
        <link rel="stylesheet" type="text/css" href="../style/manual.css" />
      </head>
      <body>
        <blockquote>
          <div align="center">
            <img src="../images/sub.gif">
            <xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='apachedocalt']"/></xsl:attribute></img>
            <h3><xsl:value-of select="$messages/message[@name='apachehttpserver']"/></h3>
          </div>
          <h1 align="center"><xsl:value-of select="title"/></h1>
          <xsl:apply-templates select="summary" />
          <h2><xsl:value-of select="$messages/message[@name='corefeatures']"/></h2>
          <dl>
            <xsl:for-each select="document(modulefilelist/modulefile)/modulesynopsis">
              <xsl:sort select="name"/>
              <xsl:if test="status='MPM' or status='Core'">
                <dt><a href="{name}.html"><xsl:value-of select="name"/></a></dt>
                <dd><xsl:apply-templates select="description"/></dd>
              </xsl:if>
            </xsl:for-each>
          </dl>
          <h2><xsl:value-of select="$messages/message[@name='othermodules']"/></h2>
          <dl>
            <xsl:for-each select="document(modulefilelist/modulefile)/modulesynopsis">
              <xsl:sort select="name"/>
              <xsl:if test="status!='MPM' and status!='Core'">
                <dt><a href="{name}.html"><xsl:value-of select="name"/></a></dt>
                <dd><xsl:apply-templates select="description"/></dd>
              </xsl:if>
            </xsl:for-each>
          </dl>
        </blockquote>
        <!-- Page footer -->
        <hr />
        <h3 align="center"><xsl:value-of select="$messages/message[@name='apachehttpserver']"/></h3>
        <a href="./"><img src="../images/index.gif"><xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='index']"/></xsl:attribute></img></a>
        <a href="../"><img src="../images/home.gif"><xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='home']"/></xsl:attribute></img></a>
      </body>
    </html>
  </xsl:template> <!-- /moduleindex -->

  <!--                                                    -->
  <!-- <directiveindex>                                   -->
  <!-- Builds the directive index page                    -->
  <!--                                                    -->
  <xsl:template match="directiveindex">
    <html>
      <head>
        <title>
          <xsl:value-of select="title"/><xsl:value-of select="$messages/message[@name='apachetitle']"/>
        </title>
        <link rel="stylesheet" type="text/css" href="../style/manual.css" />
      </head>
      <body>
        <blockquote>
          <div align="center">
            <img src="../images/sub.gif">
            <xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='apachedocalt']"/></xsl:attribute></img>
            <h3><xsl:value-of select="$messages/message[@name='apachehttpserver']"/></h3>
          </div>
          <h1 align="center"><xsl:value-of select="title"/></h1>
          <xsl:apply-templates select="summary" />
          <ul>
            <xsl:for-each select="document(modulefilelist/modulefile)/modulesynopsis/directivesynopsis">
              <xsl:sort select="name"/>
              <xsl:if test="not(@location)">
                <li><a href="{/modulesynopsis/name}.html#{translate(name,$uppercase,$lowercase)}"><xsl:value-of select="name"/></a></li>
              </xsl:if>
            </xsl:for-each>
          </ul>
        </blockquote>
        <!-- Page footer -->
        <hr />
        <h3 align="center"><xsl:value-of select="$messages/message[@name='apachehttpserver']"/></h3>
        <a href="./"><img src="../images/index.gif"><xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='index']"/></xsl:attribute></img></a>
        <a href="../"><img src="../images/home.gif"><xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='home']"/></xsl:attribute></img></a>
      </body>
    </html>
  </xsl:template> <!-- /directiveindex -->

  <!--                                                    -->
  <!-- <modulesynopsis>                                   -->
  <!-- Process an entire document into an HTML page       -->
  <!--                                                    -->
  <xsl:template match="modulesynopsis">
    <html>
      <head>
        <!-- Do we need to translate this as well? -->
        <xsl:comment> 
          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
                This file is generated from xml source: DO NOT EDIT
          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        </xsl:comment>
        <xsl:apply-templates select="meta"/>
        <title>
          <xsl:value-of select="name"/><xsl:value-of select="$messages/message[@name='apachetitle']"/>
        </title>
        <link rel="stylesheet" type="text/css" href="../style/manual.css" />
      </head>
      <body>
        <blockquote>
          <div align="center">
            <img src="../images/sub.gif">
            <xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='apachedocalt']"/></xsl:attribute></img>
            <h3><xsl:value-of select="$messages/message[@name='apachehttpserver']"/></h3>
          </div>
          <h1 align="center"><xsl:value-of select="$messages/message[@name='apachemodule']"/><xsl:text> </xsl:text> <xsl:value-of select="name"/></h1>
          <!-- Description and module-headers -->
          <table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td>
            <table bgcolor="#ffffff">
              <tr>
                <td valign="top" nowrap="nowrap"><span class="help"><xsl:value-of select="$messages/message[@name='description']"/>:</span></td>
                <td><xsl:apply-templates select="description"/></td>
              </tr>
              <tr>
                <td nowrap="nowrap"><a class="help" href="module-dict.html#Status"><xsl:value-of select="$messages/message[@name='status']"/>:</a></td>
                <td><xsl:value-of select="status"/></td>
              </tr>
              <xsl:if test="identifier">
                <tr>
                  <td nowrap="nowrap"><a class="help" href="module-dict.html#ModuleIdentifier"><xsl:value-of select="$messages/message[@name='moduleidentifier']"/>:</a> </td>
                  <td><xsl:value-of select="identifier"/></td>
                </tr>
              </xsl:if>
              <xsl:if test="compatibility">
                <tr>
                  <td valign="top" align="left"><a class="help" href="module-dict.html#Compatibility"><xsl:value-of select="$messages/message[@name='compatibility']"/>:</a> </td>
                  <td><xsl:apply-templates select="compatibility"/></td>
                </tr>
              </xsl:if>
            </table>
          </td></tr></table>
   
          <!-- Summary of module features/usage (1 to 3 paragraphs, optional) -->
   
          <xsl:if test="summary">
            <h2><xsl:value-of select="$messages/message[@name='summary']"/></h2>
            <xsl:apply-templates select="summary"/>
          </xsl:if>
   
          <!-- Index of directives, automatically generated from directivesynopsis/name -->
          <h2><xsl:value-of select="$messages/message[@name='directives']"/></h2>
          <xsl:if test="directivesynopsis">
            <ul>
              <xsl:for-each select="directivesynopsis">
                <xsl:sort select="name"/>
                <xsl:variable name="name"><xsl:value-of select="name"/></xsl:variable>
                <xsl:variable name="lowername" select="translate($name, $uppercase, $lowercase)" />
                <xsl:if test="not(@location)">
                  <li><a href="#{$lowername}"><xsl:value-of select="name"/></a></li>
                </xsl:if>
                <xsl:if test="./@location">
                  <xsl:variable name="location"><xsl:value-of select="./@location"/></xsl:variable>
                  <xsl:variable name="lowerlocation" select="translate($location, $uppercase, $lowercase)" />
                  <li><a href="{$lowerlocation}.html#{$lowername}"><xsl:value-of select="name"/></a></li>
                </xsl:if>
              </xsl:for-each>
            </ul>
          </xsl:if>
          <xsl:if test="not(directivesynopsis)">
            <p><xsl:value-of select="$messages/message[@name='nodirectives']"/></p>
          </xsl:if>
   
          <xsl:if test="seealso">
            <p><strong><xsl:value-of select="$messages/message[@name='seealso']"/></strong></p>
            <ul>
              <xsl:for-each select="seealso">
                <li><xsl:apply-templates/></li>
              </xsl:for-each>
            </ul>
          </xsl:if>
   
          <!-- Sections of documentation about the module as a whole -->
          <xsl:apply-templates select="section"/>
          <hr />
   
          <!-- Directive documentation -->
          <xsl:apply-templates select="directivesynopsis">
            <xsl:sort select="name"/>
          </xsl:apply-templates> 
   
        </blockquote>
        <!-- Page footer -->
        <h3 align="center"><xsl:value-of select="$messages/message[@name='apachehttpserver']"/></h3>
        <a href="./"><img src="../images/index.gif"><xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='index']"/></xsl:attribute></img></a>
        <a href="../"><img src="../images/home.gif"><xsl:attribute name="alt"><xsl:value-of select="$messages/message[@name='home']"/></xsl:attribute></img></a>
      </body>
    </html>
  </xsl:template><!-- /modulesynopsis -->
  
  
  <!-- Subsections: get a lower level heading -->
    <xsl:template match="section/section">
     <xsl:variable name="href">
        <xsl:value-of select="@id"/>
      </xsl:variable>
        <!-- Section heading -->
      <xsl:if test="@id">
        <h3><a name="{$href}"><xsl:apply-templates select="./title" mode="print"/></a></h3>
      </xsl:if>
      <xsl:if test="not(@id)">
        <h3><xsl:apply-templates select="./title" mode="print"/></h3>
      </xsl:if>
        <!-- Section body -->
          <xsl:apply-templates/>
    </xsl:template>
  
  <!-- Process a documentation section -->
    <xsl:template match="section">
      <xsl:variable name="href">
        <xsl:value-of select="@id"/>
      </xsl:variable>
        <!-- Section heading -->
      <xsl:if test="@id">
        <h2><a name="{$href}"><xsl:apply-templates select="./title" mode="print"/></a></h2>
      </xsl:if>
      <xsl:if test="not(@id)">
        <h2><xsl:apply-templates select="./title" mode="print"/></h2>
      </xsl:if>
        <!-- Section body -->
          <xsl:apply-templates/>
    </xsl:template>
  
    <xsl:template match="section/title" mode="print">
      <xsl:apply-templates/>
    </xsl:template>
  
    <!-- Don't print the title twice -->
    <xsl:template match="section/title"></xsl:template>
  
  <xsl:template match="directivesynopsis">

  <xsl:if test="not(@location)">
  <xsl:variable name="name">
    <xsl:value-of select="./name"/>
  </xsl:variable>
  <xsl:variable name="lowername" 
     select="translate($name, $uppercase, $lowercase)" />
  <!-- Directive heading gets both mixed case and lowercase anchors,
       and includes lt/gt only for "section" directives -->
  <h2><a name="{$name}"><xsl:if test="./@type='section'">&lt;</xsl:if
      ><xsl:value-of select="./name"/><xsl:if test="./@type='section'"
      >&gt;</xsl:if></a><xsl:text> </xsl:text><a 
      name="{$lowername}"><xsl:value-of select="$messages/message[@name='directive']"/></a></h2>

<!-- Directive header -->
<table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1">
<tr><td>
<table bgcolor="#ffffff">
  <tr>
    <td nowrap="nowrap"><strong><xsl:value-of select="$messages/message[@name='description']"/>: </strong></td>
    <td><xsl:value-of select="description"/></td>
  </tr>
  <tr>
    <td nowrap="nowrap"><a class="help" href="directive-dict.html#Syntax"><xsl:value-of select="$messages/message[@name='syntax']"/>:</a> </td>
    <td><xsl:apply-templates select="syntax"/></td>
  </tr>
  <xsl:if test="default">
    <tr>
      <td nowrap="nowrap"><a class="help" href="directive-dict.html#Default"><xsl:value-of select="$messages/message[@name='default']"/>:</a> </td>
      <td><code><xsl:value-of select="default"/></code></td>
    </tr>
    </xsl:if>
      <tr>
        <td nowrap="nowrap"><a class="help" href="directive-dict.html#Context"><xsl:value-of select="$messages/message[@name='context']"/>:</a> </td>
        <td><xsl:apply-templates select="contextlist"/></td>
      </tr>
      <xsl:if test="override">
        <tr>
          <td nowrap="nowrap"><a class="help" href="directive-dict.html#Override"><xsl:value-of select="$messages/message[@name='override']"/>:</a> </td>
          <td><xsl:value-of select="override"/></td>
        </tr>
        </xsl:if>
        <tr>
          <td nowrap="nowrap"><a class="help" href="directive-dict.html#Status"><xsl:value-of select="$messages/message[@name='status']"/>:</a> </td>
          <td><xsl:value-of select="/modulesynopsis/status"/></td>
        </tr>
        <tr>
          <td nowrap="nowrap"><a class="help" href="directive-dict.html#Module"><xsl:value-of select="$messages/message[@name='module']"/>:</a> </td>
          <td>
            <xsl:if test="modulelist"><xsl:apply-templates select="modulelist"/></xsl:if>
            <xsl:if test="not(modulelist)">
              <xsl:value-of select="/modulesynopsis/name"/>
            </xsl:if>
            </td>
          </tr>
          <xsl:if test="compatibility">
            <tr>
              <td valign="top" align="left" nowrap="nowrap"><a class="help" href="directive-dict.html#Compatibility"><xsl:value-of select="$messages/message[@name='compatibility']"/>:</a> </td>
              <td><xsl:value-of select="compatibility"/></td>
            </tr>
          </xsl:if>
        </table>
      </td></tr></table>

      <xsl:apply-templates select="usage"/>
      <xsl:if test="seealso">
        <p><strong><xsl:value-of select="$messages/message[@name='seealso']"/></strong></p>
        <ul>
          <xsl:for-each select="seealso">
            <li><xsl:apply-templates/></li>
          </xsl:for-each>
        </ul>
      </xsl:if>
      <hr />
    </xsl:if> <!-- not(@location) -->
  </xsl:template> <!-- /directivesynopsis -->

  <!--                                                    -->
  <!-- <contextlist>                                      -->
  <!-- Passes through content                             -->
  <!--                                                    -->
  <xsl:template match="contextlist">
    <xsl:apply-templates select="context"/>
  </xsl:template> <!-- /contextlist -->

  <!--                                                    -->
  <!-- <context>                                          -->
  <!-- Each entry is separeted with a comma               -->
  <!--                                                    -->
  <xsl:template match="context">
    <xsl:value-of select="." />
    <xsl:if test="not(position()=last())">, </xsl:if>
  </xsl:template> <!-- /context -->

  <!--                                                    -->
  <!-- <modulelist>                                       -->
  <!-- Passes through content                             -->
  <!--                                                    -->
  <xsl:template match="modulelist">
    <xsl:apply-templates select="module"/>
  </xsl:template> <!-- /modulelist -->

  <!--                                                    -->
  <!-- <example>                                          -->
  <!-- Examples are set in a "colored" table.             -->
  <!--                                                    -->
  <xsl:template match="example">
    <blockquote>
      <table cellpadding="10"><tr><td bgcolor="#eeeeee">
        <xsl:apply-templates select="title" mode="print"/>
        <code><xsl:apply-templates/></code>
      </td></tr></table>
    </blockquote>
  </xsl:template> <!-- /example -->

  <!--                                                    -->
  <!-- <example><title>                                   -->
  <!--                                                    -->
  <xsl:template match="example/title" mode="print">
    <p align="center"><strong><xsl:apply-templates/></strong></p>
  </xsl:template> <!-- /example/title -->

  <!--                                                    -->
  <!-- <example><title>                                   -->
  <!--                                                    -->
  <xsl:template match="example/title"></xsl:template>

  <!--                                                    -->
  <!-- <note>                                             -->
  <!-- Notes are placed in a table. Uses different back-  -->
  <!-- ground colors, depending on type of note.          -->
  <!--                                                    -->
  <xsl:template match="note">
  <blockquote>
  <table><tr><td>
   <xsl:choose>
    <xsl:when test="@type='warning'">
     <xsl:attribute name="bgcolor">#ffe5f5</xsl:attribute>
    </xsl:when>
    <xsl:otherwise>
     <xsl:attribute name="bgcolor">#e0e5f5</xsl:attribute>
    </xsl:otherwise>
   </xsl:choose>
     <xsl:apply-templates/>
  </td></tr></table>
  </blockquote>
  </xsl:template>  <!-- /note -->


  <!--                                                    -->
  <!-- <note><title>                                      -->
  <!--                                                    -->
  <xsl:template match="note/title">
     <p align="center"><strong><xsl:apply-templates/></strong></p>
  </xsl:template> <!-- /note/title -->

  <!--                                                    -->
  <!-- <directive>                                        -->
  <!-- Inserts link to another directive, which might be  -->
  <!-- in another module. References are converted into   --> 
  <!-- lower case.                                        -->
  <!--                                                    -->
  <xsl:template match="directive">
    <xsl:if test="@module">
      <xsl:variable name="module">
        <xsl:value-of select="./@module"/>
      </xsl:variable>
      <xsl:variable name="directive">
        <xsl:value-of select="."/>
      </xsl:variable>
      <xsl:variable name="lowerdirective" select="translate($directive, $uppercase, $lowercase)" />
      <xsl:if test="@module=/modulesynopsis/name">
        <a class="directive" href="#{$lowerdirective}"><code class="directive"><xsl:if test="./@type='section'">&lt;</xsl:if><xsl:value-of select="."/><xsl:if test="./@type='section'">&gt;</xsl:if></code></a>
      </xsl:if>
      <xsl:if test="@module!=/modulesynopsis/name">
        <a class="directive" href="{$module}.html#{$lowerdirective}"><code class="directive"><xsl:if test="./@type='section'">&lt;</xsl:if><xsl:value-of select="."/><xsl:if test="./@type='section'">&gt;</xsl:if></code></a>
      </xsl:if>
    </xsl:if>
    <xsl:if test="not(@module)">
       <code class="directive"><xsl:if test="./@type='section'">&lt;</xsl:if><xsl:value-of select="."/><xsl:if test="./@type='section'">&gt;</xsl:if></code>
    </xsl:if>
  </xsl:template> <!-- /directive -->

  <!--                                                    -->
  <!-- <module>                                           -->
  <!-- Inserts a link to refereed module                  -->
  <!--                                                    -->
  <xsl:template match="module">
    <code><a href="{.}.html"><xsl:value-of select="."/></a></code><xsl:if test="parent::modulelist"><xsl:if test="not(position()=last())">, </xsl:if>
    </xsl:if>
  </xsl:template> <!-- /module -->

  <!--                                                    -->
  <!-- <summary>                                          -->
  <!-- Passes through content                             -->
  <!--                                                    -->
  <xsl:template match="summary">
    <xsl:apply-templates/>
  </xsl:template> <!-- /summary -->

  <!--                                                    -->
  <!-- <description>                                      -->
  <!-- Passes through content                             -->
  <!--                                                    -->
  <xsl:template match="description">
    <xsl:apply-templates/>
  </xsl:template> <!-- /description -->

  <!--                                                    -->
  <!-- <usage>                                            -->
  <!-- Passes through content                             -->
  <!--                                                    -->
  <xsl:template match="usage">
    <xsl:apply-templates/>
  </xsl:template> <!-- /usage -->

  <!--                                                    -->
  <!-- <syntax>                                           -->
  <!-- Passes through content                             -->
  <!--                                                    -->
  <xsl:template match="syntax">
    <xsl:apply-templates/>
  </xsl:template> <!-- /syntax -->

  <!--                                                    -->
  <!-- Process everything else by just passing it through -->
  <!--                                                    -->
  <xsl:template match="*|@*">
    <xsl:copy>
      <xsl:apply-templates select="@*|*|text()"/>
    </xsl:copy>
  </xsl:template>

</xsl:stylesheet>