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
|
## -*- tcl -*-
# ### ### ### ######### ######### #########
##
# $Id: idx.html,v 1.8 2007/03/20 05:06:35 andreas_kupries Exp $
#
# Index Formatting Engine : docidx --> HTML.
# Single-pass
#
# Copyright (c) 2003-2007 Andreas Kupries <andreas_kupries@sourceforge.net>
# Freely redistributable.
# ### ### ### ######### ######### #########
## Requisites
dt_source _idx_common.tcl
dt_source _html.tcl
# ### ### ### ######### ######### #########
## API implementation
rename idx_postprocess {}
rename fmt_postprocess idx_postprocess
proc fmt_plain_text {text} {return {}}
proc fmt_index_begin {l t} {
global la ti
set la $l
set ti $t
return {}
}
proc fmt_key {text} {
global key lk ch
set lk $text
set key($lk) {}
set ch([F $lk]) .
return {}
}
proc fmt_manpage {f l} {Ref [dt_fmap $f] $l}
proc fmt_url {u l} {Ref $u $l}
proc fmt_index_end {} {
LoadKwid
set lines {}
if {![Get raw]} {
BeginHeader ; Meta ; EndHeader
BeginBody
}
BodyHeader ; Title ; Navbar
BeginIndex ; Keys ; EndIndex
if {![Get raw]} {
EndBody
}
return [join $lines \n]
}
# ### ### ### ######### ######### #########
## Helper commands
proc Ref {r l} {
global key lk
lappend key($lk) $r $l
return {}
}
proc F {text} {
# Keep only alphanumeric, take first, uppercase
# Returns nothing if input has no alphanumeric characters.
return [string toupper [string index [regsub -all {[^a-zA-Z0-9]} $text {}] 0]]
}
proc LoadKwid {} {
global kwid
# Engine parameter - load predefined keyword anchors.
set ki [Get kwid]
if {![llength $ki]} return
array set kwid $ki
return
}
proc BeginHeader {} {
global la ti
upvar 1 lines lines
lappend lines [markup {<!DOCTYPE html>}]
lappend lines [markup <html>]
lappend lines [ht_comment [c_provenance]]
lappend lines [ht_comment "$la"]
lappend lines [markup <head>]
lappend lines [markup {<meta charset="UTF-8">}]
lappend lines [taga meta {name viewport content {width=device-width, initial-scale=1}}] \n
lappend lines "[markup <title>] $la [markup </title>]"
return
}
proc Meta {} {
# Engine parameter - insert 'meta'
set meta [Get meta]
if {$meta == {}} return
upvar 1 lines lines
lappend lines [markup $meta]
return
}
proc EndHeader {} {
upvar 1 lines lines
lappend lines [markup </head>]
return
}
proc BeginBody {} {
upvar 1 lines lines
lappend lines [markup <body>]
return
}
proc BodyHeader {} {
upvar 1 lines lines
# Engine parameter - insert 'header'
set header [Get header]
if {$header == {}} return
lappend map @TITLE@ [TheTitle]
set header [string map $map $header]
lappend lines [markup $header]
return
}
proc TheTitle {} {
global la ti
set title ???
if {($la != {}) && ($ti != {})} {
set title "$la -- $ti"
} elseif {$la != {}} {
set title $la
} elseif {$ti != {}} {
set title $ti
}
return $title
}
proc Title {} {
upvar 1 lines lines
lappend lines "[markup <h3>] [TheTitle] [markup </h3>]"
return
}
proc Navbar {} {
global ch cnt dot
upvar 1 lines lines
set nav {}
foreach c [lsort -dict [array names ch]] {
set ref c[F $c];#[incr cnt]
set ch($c) $ref
lappend nav [ALink $ref $c]
}
lappend lines [markup "<hr><div class=\"doctools_idxnav\">"]
lappend lines [join $nav $dot]
lappend lines [markup </div>]
return
}
proc BeginIndex {} {
upvar 1 lines lines
lappend lines [markup "<hr><table class=\"doctools_idx\" width=\"100%\">"]
return
}
proc Keys {} {
global key
upvar 1 lines lines
set lc {}
set kwlist {}
# For a good display we sort keywords in dictionary order.
# We ignore their leading non-alphanumeric characters.
set kwlist {}
foreach kw [array names key] {
set kwx [string trim [regsub -all {^[^a-zA-Z0-9]+} $kw {}]]
lappend kwlist [list $kwx $kw]
}
foreach item [lsort -index 0 -dict $kwlist] {
foreach {_ k} $item break
set c [F $k] ; if {$lc != $c} { Section $c ; set lc $c }
BeginKey $k
References $k
EndKey
}
return
}
proc Section {c} {
global ch
upvar 1 lines lines
lappend lines [markup {<tr class="doctools_idxheader"><th colspan="2">}]
lappend lines [markup "<a name=\"$ch($c)\">Keywords: $c</a>"]
lappend lines [markup </th></tr>]
return
}
proc BeginKey {k} {
upvar 1 lines lines
lappend lines [markup "<tr class=\"[Row]\" valign=top>"]
lappend lines [BeginColLeft][SetAnchor $k][markup </td>]
lappend lines [BeginColRight]
return
}
proc EndKey {} {
upvar 1 lines lines
lappend lines [markup </td></tr>]
return
}
proc References {k} {
global key dot
upvar 1 lines lines
set refs {}
foreach {ref label} $key($k) {
lappend refs [markup "<a href=\"$ref\"> $label </a>"]
}
lappend lines [join $refs $dot]
return
}
proc EndIndex {} {
upvar 1 lines lines
lappend lines [markup </table>]
# Engine parameter - insert 'footer'
set footer [Get footer]
if {$footer == {}} return
lappend lines [markup "<hr>"]
lappend lines [markup $footer]
return
}
proc EndBody {} {
upvar 1 lines lines
lappend lines [markup "</body></html>"]
return
}
proc ALink {dst label} {
markup "<a href=\"#$dst\"> $label </a>"
}
proc BeginColLeft {} {
return [markup {<td class="doctools_idxleft" width="35%">}]
}
proc BeginColRight {} {
return [markup {<td class="doctools_idxright" width="65%">}]
}
proc SetAnchor {text} {
return [markup "<a name=[Anchor $text]> $text </a>"]
}
proc A {text} {
set anchor [regsub -all {[^a-zA-Z0-9]} [string tolower $text] {_}]
set anchor [regsub -all {__+} $anchor _]
return $anchor
}
proc Anchor {text} {
global kwid
if {[info exists kwid($text)]} {
return "\"$kwid($text)\""
}
return "\"[A $text]\""
}
proc Row {} {
global even
set res [expr {$even
? "doctools_idxeven"
: "doctools_idxodd"}]
Flip
return $res
}
proc Flip {} {
global even
set even [expr {1-$even}]
return
}
# ### ### ### ######### ######### #########
## Engine state
# key : string -> dict(ref -> label) "key formatting"
# ch : string -> '.' "key starting characters"
# lk : string "last key"
# la : string "index label"
# ti : string "index title"
# cnt : int
# kwid : string -> ...
# even : bool
global key ; array set key {}
global ch ; array set ch {}
global lk ; set lk {}
global la ; set la {}
global ti ; set ti {}
global cnt ; set cnt 0
global kwid ; array set kwid {}
global even ; set even 1
global dot ; set dot [markup { · }]
# ### ### ### ######### ######### #########
## Engine parameters
global __var
array set __var {
meta {}
header {}
footer {}
kwid {}
raw 0
}
proc Get {varname} {global __var ; return $__var($varname)}
proc idx_listvariables {} {global __var ; return [array names __var]}
proc idx_varset {varname text} {
global __var
if {![info exists __var($varname)]} {return -code error "Unknown engine variable \"$varname\""}
set __var($varname) $text
return
}
##
# ### ### ### ######### ######### #########
|
