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
|
# -*- tcl -*-
# sak::doc::auto - Documentation facilities, support for automatic
# list of manpages, keyword index, and table of contents.
package require sak::util
namespace eval ::sak::doc::auto {
set here [file dirname [file normalize [info script]]]
}
getpackage fileutil fileutil/fileutil.tcl
getpackage doctools doctools/doctools.tcl
getpackage textutil::repeat textutil/repeat.tcl
# ###
# API commands
proc ::sak::doc::auto::manpages {} {
variable here
return [file join $here manpages.txt]
}
proc ::sak::doc::auto::kwic {} {
variable here
return [file join $here kwic.txt]
}
proc ::sak::doc::auto::toc {{name toc.txt}} {
variable here
return [file join $here $name]
}
## ### ### ### ######### ######### #########
proc ::sak::doc::auto::findManpages {base {excluded {}}} {
set top [file normalize $base]
set manpages {}
foreach page [glob -nocomplain -directory $top/modules */*.man] {
set rpage [fileutil::stripPath $top $page]
# rpage = modules/*/foo.man
set m [file tail [file dirname $rpage]]
if {[isExcluded $excluded $m]} continue
lappend manpages $rpage
}
foreach page [glob -nocomplain -directory $top/apps *.man] {
lappend manpages [fileutil::stripPath $top $page]
}
return [lsort -dict $manpages]
}
proc ::sak::doc::auto::isExcluded {excluded m} {
foreach e $excluded {
if {$e eq $m} { return yes }
}
return no
}
proc ::sak::doc::auto::saveManpages {manpages} {
fileutil::writeFile [manpages] [join [lsort -dict $manpages] \n]\n
return
}
proc ::sak::doc::auto::loadManpages {} {
return [lsort -dict [split [fileutil::cat [manpages]] \n]]
}
## ### ### ### ######### ######### #########
proc ::sak::doc::auto::scanManpages {manpages} {
::doctools::new dt -format list
set data {}
puts Scanning...
foreach page $manpages {
puts ...$page
if {![file size $page]} { puts "\tEMPTY, IGNORED" ; continue }
dt configure -ibase $page
lappend data $page [lindex [dt format [fileutil::cat $page]] 1]
}
dt destroy
return $data
}
## ### ### ### ######### ######### #########
proc ::sak::doc::auto::saveKeywordIndex {kv nv} {
upvar 1 $kv kwic $nv name
# kwic: keyword -> list (files)
# name: file -> label
TagsBegin
Tag+ index_begin [list {Keyword Index} {}]
# For a good display we sort keywords in dictionary order.
# We ignore their leading non-alphanumeric characters.
set kwlist {}
foreach kw [array names kwic] {
set kwx [string trim [regsub -all {^[^a-zA-Z0-9]+} $kw {}]]
lappend kwlist [list $kwx $kw]
}
foreach item [lsort -index 0 -dict $kwlist] {
foreach {_ kw} $item break
set tmp [Sortable $kwic($kw) name max _]
Tag+ key [list $kw]
foreach item [lsort -dict -index 0 $tmp] {
foreach {label file} $item break
Tag+ manpage [FmtR max $file] [list $label]
}
}
Tag+ index_end
fileutil::writeFile [kwic] [join $lines \n]
return
}
## ### ### ### ######### ######### #########
proc ::sak::doc::auto::saveTableOfContents {tv nv cv av mv} {
upvar 1 $tv title $nv name $cv cat $av apps $mv mods
# title: file -> description
# name: file -> label
# cat: category -> list (file...)
TagsBegin
Tag+ toc_begin [list {Table Of Contents} {}]
# The man pages are sorted in several ways for the toc.
# 1. First section by category. Subsections are categories.
# Sorted by category name, in dictionary order.
# Inside the subsections the files, sorted by label and
# description.
# 2. Second section for types. Subsections are modules and apps.
# Apps first, then modules. For apps items directly, sorted
# by name and description. For modules one sub-subsection
# per module, elements the packages, sorted by label and
# description.
Tag+ division_start [list {By Categories}]
foreach c [lsort -dict [array names cat]] {
Tag+ division_start [list $c]
foreach item [lsort -dict -index 0 [Sortable $cat($c) name maxf maxl]] {
foreach {label file} $item break
Tag+ item \
[FmtR maxf $file] \
[FmtR maxl $label] \
[list $title($file)]
}
Tag+ division_end
}
Tag+ division_end
Tag+ division_start [list {By Type}]
# Not handled: 'no applications'
Tag+ division_start [list {Applications}]
foreach item [lsort -dict -index 0 [Sortable $apps name maxf maxl]] {
foreach {label file} $item break
Tag+ item \
[FmtR maxf $file] \
[FmtR maxl $label] \
[list $title($file)]
}
Tag+ division_end
# Not handled: 'no modules'
Tag+ division_start [list {Modules}]
foreach m [lsort -dict [array names mods]] {
Tag+ division_start [list $m]
foreach item [lsort -dict -index 0 [Sortable $mods($m) name maxf maxl]] {
foreach {label file} $item break
Tag+ item \
[FmtR maxf $file] \
[FmtR maxl $label] \
[list $title($file)]
}
Tag+ division_end
}
Tag+ division_end
Tag+ division_end
Tag+ toc_end
fileutil::writeFile [toc] [join $lines \n]
return
}
proc ::sak::doc::auto::saveSimpleTableOfContents1 {tv nv dv fname} {
upvar 1 $tv title $nv name $dv data
# title: file -> description
# name: file -> label
# data: list(file...)
TagsBegin
Tag+ toc_begin [list {Table Of Contents} {}]
# The man pages are sorted in several ways for the toc.
# Subsections are the modules or apps, whatever is in data.
# Not handled: 'no applications'
Tag+ division_start [list {Applications}]
foreach item [lsort -dict -index 0 [Sortable $data name maxf maxl]] {
foreach {label file} $item break
Tag+ item \
[FmtR maxf $file] \
[FmtR maxl $label] \
[list $title($file)]
}
Tag+ division_end
Tag+ toc_end
fileutil::writeFile [toc $fname] [join $lines \n]
return
}
proc ::sak::doc::auto::saveSimpleTableOfContents2 {tv nv dv fname} {
upvar 1 $tv title $nv name $dv data
# title: file -> description
# name: file -> label
# data: module -> list (file...)
TagsBegin
Tag+ toc_begin [list {Table Of Contents} {}]
# The man pages are sorted in several ways for the toc.
# Subsections are the modules or apps, whatever is in data.
# Not handled: 'no modules'
Tag+ division_start [list {Modules}]
foreach m [lsort -dict [array names data]] {
Tag+ division_start [list $m]
foreach item [lsort -dict -index 0 [Sortable $data($m) name maxf maxl]] {
foreach {label file} $item break
Tag+ item \
[FmtR maxf $file] \
[FmtR maxl $label] \
[list $title($file)]
}
Tag+ division_end
}
Tag+ division_end
Tag+ toc_end
fileutil::writeFile [toc $fname] [join $lines \n]
return
}
proc ::sak::doc::auto::saveSimpleTableOfContents3 {tv nv cv fname} {
upvar 1 $tv title $nv name $cv cat
# title: file -> description
# name: file -> label
# cat: category -> list (file...)
TagsBegin
Tag+ toc_begin [list {Table Of Contents} {}]
Tag+ division_start [list {By Categories}]
foreach c [lsort -dict [array names cat]] {
Tag+ division_start [list $c]
foreach item [lsort -dict -index 0 [Sortable $cat($c) name maxf maxl]] {
foreach {label file} $item break
Tag+ item \
[FmtR maxf $file] \
[FmtR maxl $label] \
[list $title($file)]
}
Tag+ division_end
}
Tag+ division_end
Tag+ toc_end
fileutil::writeFile [toc $fname] [join $lines \n]
return
}
proc ::sak::doc::auto::Sortable {files nv mfv mnv} {
upvar 1 $nv name $mfv maxf $mnv maxn
# Generate a list of files sortable by name, and also find the
# max length of all relevant names.
set maxf 0
set maxn 0
set tmp {}
foreach file $files {
lappend tmp [list $name($file) $file]
Max maxf $file
Max maxn $name($file)
}
return $tmp
}
## ### ### ### ######### ######### #########
proc ::sak::doc::auto::Max {v str} {
upvar 1 $v max
set x [string length $str]
if {$x <= $max} return
set max $x
return
}
proc ::sak::doc::auto::FmtR {v str} {
upvar 1 $v max
return [list $str][textutil::repeat::blank \
[expr {$max - [string length [list $str]]}]]
}
## ### ### ### ######### ######### #########
proc ::sak::doc::auto::Tag {n args} {
if {[llength $args]} {
return "\[$n [join $args]\]"
} else {
return "\[$n\]"
}
#return \[[linsert $args 0 $n]\]
}
proc ::sak::doc::auto::Tag+ {n args} {
upvar 1 lines lines
lappend lines [eval [linsert $args 0 ::sak::doc::auto::Tag $n]]
return
}
proc ::sak::doc::auto::TagsBegin {} {
upvar 1 lines lines
set lines {}
return
}
## ### ### ### ######### ######### #########
package provide sak::doc::auto 1.0
|