4
Licensed to the Apache Software Foundation (ASF) under one or more
5
contributor license agreements. See the NOTICE file distributed with
6
this work for additional information regarding copyright ownership.
7
The ASF licenses this file to You under the Apache License, Version 2.0
8
(the "License"); you may not use this file except in compliance with
9
the License. You may obtain a copy of the License at
11
http://www.apache.org/licenses/LICENSE-2.0
13
Unless required by applicable law or agreed to in writing, software
14
distributed under the License is distributed on an "AS IS" BASIS,
15
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
See the License for the specific language governing permissions and
17
limitations under the License.
20
<!DOCTYPE xsl:stylesheet [
21
<!ENTITY lf SYSTEM "../xsl/util/lf.xml">
22
<!ENTITY tab SYSTEM "../xsl/util/tab.xml">
24
<!ENTITY ul.start SYSTEM "../xsl/util/ul-start.xml">
25
<!ENTITY ul.end SYSTEM "../xsl/util/ul-end.xml" >
26
<!ENTITY li.start SYSTEM "../xsl/util/li-start.xml">
27
<!ENTITY li.end SYSTEM "../xsl/util/li-end.xml" >
29
<xsl:stylesheet version="1.0"
30
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
34
<!-- WARNING! Do not touch anything, especially the whitespaces [1] -->
35
<!-- unless you know, what you're doing. The HTML help compiler parses -->
36
<!-- the TOC file not really as html instead of line by line and takes -->
37
<!-- care of whitespace indentations etc. -->
39
<!-- [1] Covered by the &lf; and &tab; entities. -->
41
<!-- You have been warned. -->
44
<!-- create nodeset for referencing later -->
45
<xsl:variable name="not-exists" select="document('')/xsl:stylesheet/xsl:template
46
[@name='data']/not-exists/file" />
48
<xsl:template name="data">
49
<!-- documents not converted (yet?). -->
51
<!-- example: <file>developer/API.xml</file> -->
55
<!-- Constants used for case translation -->
56
<xsl:variable name="lowercase" select="'abcdefghijklmnopqrstuvwxyz'" />
57
<xsl:variable name="uppercase" select="'ABCDEFGHIJKLMNOPQRSTUVWXYZ'" />
59
<!-- document() works relative to the xsl (!) file -->
60
<xsl:variable name="basedir" select="'../../'"/>
63
<xsl:variable name="icon.document" select="'11'" />
64
<xsl:variable name="icon.document.not-translated" select="'12'" />
65
<xsl:variable name="icon.section" select="'35'" />
66
<xsl:variable name="icon.directive" select="'41'" />
67
<xsl:variable name="icon.commondirective" select="'19'" />
68
<!-- this should not happen. this icon is only displayed within the
69
toc view of the help workshop (it's a question mark): -->
70
<xsl:variable name="icon.no-anchor" select="'9'" />
72
<!-- for module-translatename -->
73
<xsl:include href="../xsl/util/modtrans.xsl"/>
75
<!-- ==================================================================== -->
77
<!-- Create CHM contents file (toc) from sitemap -->
78
<!-- The file is an html style text file (see warning on top) -->
79
<!-- ==================================================================== -->
80
<xsl:template match="/sitemap">
83
<xsl:text><html><head></xsl:text>
84
<xsl:text><title>Apache HTTP Server Documentation</title></xsl:text>
85
<xsl:text></head></xsl:text>&lf;
87
<xsl:text><body></xsl:text>&lf;
89
<!-- toc properties first -->
90
<xsl:text><object type="text/site properties"></xsl:text>&lf;&tab;
91
<!-- XXX: that magic value is still obfuscated. Research needed ... -->
92
<xsl:text><param name="Window Styles" value="0x800027"></xsl:text>&lf;&tab;
93
<xsl:text><param name="Font" value="</xsl:text>
94
<xsl:value-of select="$toc-font" />
95
<xsl:text>"></xsl:text>&lf;
96
<xsl:text></object></xsl:text>&lf;
100
<!-- index page on top. -->
102
<xsl:call-template name="object">
103
<xsl:with-param name="name"
104
select="normalize-space($message[@id='apachehttpserver'])" />
105
<xsl:with-param name="href" select="'index.html'" />
106
<xsl:with-param name="indent" select="'		'" />
110
<!-- iterate over the categories in document order -->
111
<xsl:for-each select="category">
113
<xsl:call-template name="folder">
114
<xsl:with-param name="name" select="normalize-space(title)" />
115
</xsl:call-template>&lf;&tab;
118
<xsl:apply-templates select="page" />
119
<xsl:if test="@id = 'modules'">
120
<xsl:apply-templates select="document($allmodules)/modulefilelist" />
128
<xsl:text></body></html></xsl:text>&lf;
133
<!-- ==================================================================== -->
134
<!-- category/page -->
135
<!-- ==================================================================== -->
136
<xsl:template match="category/page">
139
<!-- document entry, if not href attribute, assume it means "sitemap" -->
140
<xsl:call-template name="object">
141
<xsl:with-param name="name">
143
<xsl:when test="@href">
144
<xsl:value-of select="normalize-space(.)" />
147
<xsl:value-of select="normalize-space($message[@id='sitemap'])" />
151
<xsl:with-param name="href">
153
<xsl:when test="not(@href)">
154
<xsl:text>sitemap.html</xsl:text>
156
<xsl:when test="contains(@href, '#')">
157
<xsl:value-of select="substring-before(@href, '#')" />
160
<xsl:value-of select="@href"/>
164
<xsl:with-param name="indent" select="'		'" />
167
<!-- now try to index the sections of the document -->
168
<xsl:apply-templates select="self::page" mode="index" />
172
<!-- /category/page -->
175
<!-- ==================================================================== -->
176
<!-- category/page, mode="index" -->
177
<!-- display all section headings of one page -->
178
<!-- ==================================================================== -->
179
<xsl:template match="category/page" mode="index">
180
<xsl:variable name="href.offline">
182
<xsl:when test="string-length(@href) = 0">
183
<xsl:text>sitemap.html</xsl:text>
186
<xsl:call-template name="helper.href.offline">
187
<xsl:with-param name="href" select="@href" />
192
<xsl:variable name="xml"
193
select="concat(substring-before($href.offline, '.html'), '.xml')" />
195
<xsl:if test="not($xml = $not-exists)">
196
<xsl:variable name="xmlfile">
197
<xsl:variable name="metafile"
198
select="document(document(concat($basedir, $xml))/*/@metafile)
201
<xsl:when test="$metafile/variants/variant[.=$doclang] and not
202
($metafile/variants/variant[.=$doclang]
203
/@htmlonly = 'yes')">
204
<xsl:value-of select="concat($basedir,
205
substring-before($xml, '.xml'), $xml-ext)" />
208
<xsl:value-of select="concat($basedir, $xml)" />
213
<xsl:variable name="current" select="document($xmlfile)" />
215
<xsl:if test="count($current/*/*[local-name()='section' or
216
local-name()='category']) > 1">
218
&ul.start; &lf;&tab;&tab;&tab;
220
<xsl:for-each select="$current/*/*[local-name()='section' or
221
local-name()='category']">
224
<xsl:call-template name="object">
225
<xsl:with-param name="name" select="normalize-space(title)" />
226
<xsl:with-param name="href">
229
select="concat(substring-before($xml, '.xml'),
233
<xsl:with-param name="indent" select="'				'" />
236
&li.end; &lf;&tab;&tab;
240
</xsl:if> <!-- count() > 1 -->
241
</xsl:if> <!-- xml exists -->
243
<!-- /category/page, "index" -->
246
<!-- ==================================================================== -->
247
<!-- category/modulefilelist -->
248
<!-- process all listed module files -->
249
<!-- ==================================================================== -->
250
<xsl:template match="modulefilelist">
251
<!-- create a module name translation list for sorting -->
252
<xsl:variable name="translist">
253
<xsl:text>-</xsl:text>
255
<xsl:for-each select="modulefile">
256
<xsl:variable name="current"
257
select="document(concat($basedir,'mod/',.))/modulesynopsis" />
259
<xsl:text> </xsl:text>
260
<xsl:value-of select="$current/name"/>
261
<xsl:text> </xsl:text>
262
<xsl:call-template name="module-translatename">
263
<xsl:with-param name="name" select="$current/name"/>
265
<xsl:text> -</xsl:text>
269
<!-- put core and mpm_common on top -->
270
<xsl:call-template name="toc-entry.mpm">
271
<xsl:with-param name="current"
272
select="document(concat($basedir, 'mod/', modulefile[starts-with(.,
273
'core.xml')]/text()))/modulesynopsis" />
274
<xsl:with-param name="name" select="'core'" />
277
<xsl:call-template name="toc-entry.mpm">
278
<xsl:with-param name="current"
279
select="document(concat($basedir, 'mod/', modulefile[starts-with(.,
280
'mpm_common.xml')]/text()))/modulesynopsis" />
281
<xsl:with-param name="name" select="'common'" />
284
<!-- remaining MPMs -->
285
<xsl:for-each select="modulefile">
286
<xsl:sort select="substring-before(substring-after($translist, concat('- ',
287
document(concat($basedir, 'mod/', .))/modulesynopsis/name, ' ')), ' -')" />
289
<xsl:variable name="current"
290
select="document(concat($basedir, 'mod/', .))/modulesynopsis" />
292
<xsl:if test="$current/status='MPM' and not($current/name='mpm_common')">
293
<xsl:call-template name="toc-entry.mpm">
294
<xsl:with-param name="current" select="$current" />
295
<xsl:with-param name="name" select="substring-before(
296
substring-after($translist, concat('- ', $current/name, ' ')),
302
<!-- normal modules -->
303
<xsl:for-each select="modulefile">
304
<xsl:sort select="substring-before(substring-after($translist, concat('- ',
305
document(concat($basedir, 'mod/', .))/modulesynopsis/name, ' ')), ' -')" />
307
<xsl:variable name="current"
308
select="document(concat($basedir, 'mod/', .))/modulesynopsis" />
310
<xsl:if test="not($current/status='MPM') and not($current/status='Core')">
311
<xsl:call-template name="toc-entry.module">
312
<xsl:with-param name="current" select="$current"/>
317
<!-- /category/modulefilelist -->
320
<!-- ==================================================================== -->
321
<!-- toc-entry.mpm -->
322
<!-- create entry (and initiate subsection entries) of an mpm -->
323
<!-- ==================================================================== -->
324
<xsl:template name="toc-entry.mpm">
325
<xsl:param name="current" />
326
<xsl:param name="name" />
330
<xsl:call-template name="object">
331
<xsl:with-param name="name">
333
<xsl:when test="$name='core'">
334
<xsl:value-of select="normalize-space($message[@id='apachecore'])" />
336
<xsl:when test="$name='common'">
337
<xsl:value-of select="normalize-space($message[@id='apachempmcommon'])" />
340
<xsl:value-of select="normalize-space($message[@id='apachempm'])" />
341
<xsl:text> </xsl:text>
342
<xsl:value-of select="$name" />
346
<xsl:with-param name="href"
347
select="concat('mod/', $current/name, '.html')" />
348
<xsl:with-param name="indent" select="'			'" />
351
<xsl:call-template name="sections-and-directives">
352
<xsl:with-param name="current" select="$current" />
357
<!-- /toc-entry.mpm -->
360
<!-- ==================================================================== -->
361
<!-- toc-entry.module -->
362
<!-- create entry (and initiate subsection entries) of a module -->
363
<!-- ==================================================================== -->
364
<xsl:template name="toc-entry.module">
365
<xsl:param name="current"/>
369
<xsl:call-template name="object">
370
<xsl:with-param name="name">
371
<xsl:value-of select="normalize-space($message[@id='apachemodule'])" />
372
<xsl:text> </xsl:text>
373
<xsl:value-of select="$current/name" />
375
<xsl:with-param name="href"
376
select="concat('mod/', $current/name, '.html')" />
377
<xsl:with-param name="indent" select="'			'" />
380
<xsl:call-template name="sections-and-directives">
381
<xsl:with-param name="current" select="$current" />
386
<!-- /toc-entry.module -->
389
<!-- ==================================================================== -->
390
<!-- sections-and-directives -->
391
<!-- process sections and directives of a module file -->
392
<!-- ==================================================================== -->
393
<xsl:template name="sections-and-directives">
394
<xsl:param name="current" />
396
<xsl:if test="count($current/section) > 0 or
397
count($current/directivesynopsis) > 0">
400
&ul.start; &lf;&tab;&tab;
403
<xsl:for-each select="$current/section">
406
<xsl:call-template name="object">
407
<xsl:with-param name="name" select="normalize-space(title)" />
408
<xsl:with-param name="href">
411
select="concat('mod/', $current/name, '.html#', @id)" />
414
<xsl:with-param name="indent" select="'				'" />
417
&li.end; &lf;&tab;&tab;
420
<!-- directives within the current document -->
421
<xsl:for-each select="$current/directivesynopsis[not(@location)]">
422
<xsl:sort select="name" />
425
<xsl:call-template name="object">
426
<xsl:with-param name="name">
427
<xsl:if test="@type='section'"><</xsl:if>
428
<xsl:value-of select="name"/>
429
<xsl:if test="@type='section'">></xsl:if>
431
<xsl:when test="$message[@id='directive']
432
/@replace-space-with">
433
<xsl:value-of select="$message[@id='directive']
434
/@replace-space-with" />
437
<xsl:text> </xsl:text>
440
<xsl:value-of select="normalize-space($message[@id='directive'])" />
442
<xsl:with-param name="href"
443
select="concat('mod/', $current/name, '.html#',
444
translate(name, $uppercase, $lowercase))" />
445
<xsl:with-param name="indent" select="'				'" />
446
<xsl:with-param name="icon" select="$icon.directive" />
449
&li.end; &lf;&tab;&tab;
452
<!-- directives described elsewhere -->
453
<xsl:for-each select="$current/directivesynopsis[@location]">
454
<xsl:sort select="name" />
457
<xsl:call-template name="object">
458
<xsl:with-param name="name">
459
<xsl:if test="@type='section'"><</xsl:if>
460
<xsl:value-of select="name"/>
461
<xsl:if test="@type='section'">></xsl:if>
463
<xsl:when test="$message[@id='directive']
464
/@replace-space-with">
465
<xsl:value-of select="$message[@id='directive']
466
/@replace-space-with" />
469
<xsl:text> </xsl:text>
472
<xsl:value-of select="normalize-space($message[@id='directive'])" />
474
<xsl:with-param name="href"
475
select="concat('mod/', @location, '.html#',
476
translate(name, $uppercase, $lowercase))" />
477
<xsl:with-param name="indent" select="'				'" />
478
<xsl:with-param name="icon" select="$icon.commondirective" />
481
&li.end; &lf;&tab;&tab;
485
</xsl:if> <!-- sections or directives present -->
487
<!-- /sections-and-directives -->
490
<!-- ==================================================================== -->
492
<!-- display an <object> and do some magic to select the right content -->
493
<!-- ==================================================================== -->
494
<xsl:template name="object">
495
<xsl:param name="name" select="'? unknown ?'" />
496
<xsl:param name="href" />
497
<xsl:param name="icon" select="$icon.section" />
498
<xsl:param name="indent" />
500
<xsl:variable name="href.offline">
501
<xsl:call-template name="helper.href.offline">
502
<xsl:with-param name="href" select="$href" />
506
<!-- xml file is expected to have the same basename -->
507
<xsl:variable name="xml"
508
select="concat(substring-before($href.offline, '.html'), '.xml')" />
510
<xsl:text><object type="text/sitemap"></xsl:text>&lf;
511
<xsl:value-of select="$indent" />
513
<xsl:text><param name="Name" value="</xsl:text>
514
<xsl:call-template name="filter.attval">
515
<xsl:with-param name="text" select="$name" />
517
<xsl:text>"></xsl:text>&lf;
518
<xsl:value-of select="$indent" />
520
<xsl:if test="string-length($href.offline) > 0">
521
<xsl:text><param name="Local" value="</xsl:text>
522
<xsl:call-template name="filter.attval">
523
<xsl:with-param name="text" select="$href.offline" />
525
<xsl:text>"></xsl:text>&lf;
526
<xsl:value-of select="$indent" />
529
<xsl:text><param name="ImageNumber" value="</xsl:text>
531
<xsl:when test="string-length($href.offline) > 0">
533
<xsl:when test="contains($href, '#')">
534
<xsl:value-of select="$icon" />
536
<xsl:when test="$doclang='en' or
537
(not($xml = $not-exists) and
538
(document(document(concat($basedir, $xml))
540
/metafile/variants/variant
541
[.=$doclang and not(@htmlonly='yes')]))">
542
<xsl:value-of select="$icon.document" />
545
<xsl:value-of select="$icon.document.not-translated" />
550
<xsl:value-of select="$icon.no-anchor" />
553
<xsl:text>"></xsl:text>&lf;
554
<xsl:value-of select="substring($indent, 2)" />
556
<xsl:text></object></xsl:text>
561
<!-- ==================================================================== -->
563
<!-- ==================================================================== -->
564
<xsl:template name="folder">
565
<xsl:param name="name" select="'? unknown ?'" />
567
<xsl:text><object type="text/sitemap"></xsl:text>&lf;&tab;&tab;
568
<xsl:text><param name="Name" value="</xsl:text>
569
<xsl:call-template name="filter.attval">
570
<xsl:with-param name="text" select="$name" />
572
<xsl:text>"></xsl:text>&lf;&tab;
573
<xsl:text></object></xsl:text>
578
<!-- ==================================================================== -->
579
<!-- helper.href.offline -->
580
<!-- change uri reference to work offline (/ -> /index.html) -->
581
<!-- ==================================================================== -->
582
<xsl:template name="helper.href.offline">
583
<xsl:param name="href" />
586
<xsl:when test="string-length($href) = 0" />
587
<xsl:when test="contains($href, '#') and '/' = substring($href,
588
string-length(substring-before($href, '#')), 1)">
589
<xsl:value-of select="substring-before($href, '#')" />
590
<xsl:text>index.html#</xsl:text>
591
<xsl:value-of select="substring-after($href, '#')" />
593
<xsl:when test="substring($href, string-length($href), 1) = '/'">
594
<xsl:value-of select="$href" />
595
<xsl:text>index.html</xsl:text>
598
<xsl:value-of select="$href" />
602
<!-- /helper.href.offline -->
605
<!-- ==================================================================== -->
606
<!-- filter.attval -->
607
<!-- escape special characters for being valid within an attribute -->
608
<!-- ==================================================================== -->
609
<xsl:template name="filter.attval">
610
<xsl:param name="text" />
613
<xsl:when test="contains($text, '&')">
614
<xsl:call-template name="filter.attval.special">
615
<xsl:with-param name="text" select="substring-before($text, '&')" />
617
<xsl:text>&amp;</xsl:text>
618
<xsl:call-template name="filter.attval">
619
<xsl:with-param name="text" select="substring-after($text, '&')" />
623
<xsl:call-template name="filter.attval.special">
624
<xsl:with-param name="text" select="$text" />
629
<!-- /filter.attval -->
632
<!-- ==================================================================== -->
633
<!-- filter.attval.special -->
634
<!-- accompanying template of filter.attval -->
635
<!-- ==================================================================== -->
636
<xsl:template name="filter.attval.special">
637
<xsl:param name="text" />
640
<xsl:when test="contains($text, '<')">
641
<xsl:value-of select="substring-before($text, '<')" />
642
<xsl:text>&lt;</xsl:text>
643
<xsl:call-template name="filter.attval.special">
644
<xsl:with-param name="text" select="substring-after($text, '<')" />
647
<xsl:when test="contains($text, '>')">
648
<xsl:value-of select="substring-before($text, '>')" />
649
<xsl:text>&gt;</xsl:text>
650
<xsl:call-template name="filter.attval.special">
651
<xsl:with-param name="text" select="substring-after($text, '>')" />
654
<xsl:when test="contains($text, '"')">
655
<xsl:value-of select="substring-before($text, '"')" />
656
<xsl:text>&quot;</xsl:text>
657
<xsl:call-template name="filter.attval.special">
658
<xsl:with-param name="text" select="substring-after($text, '"')" />
662
<xsl:value-of select="$text" />
666
<!-- /filter.attval.special -->
added
removed
docs/manual/style/xsl/hhc.xsl
