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
|
# -*- tcl -*-
# sak::doc - Documentation facilities
package require sak::util
package require sak::doc
namespace eval ::sak::localdoc {}
# ###
# API commands
## ### ### ### ######### ######### #########
proc ::sak::localdoc::usage {} {
package require sak::help
puts stdout \n[sak::help::on localdoc]
exit 1
}
proc ::sak::localdoc::run {} {
getpackage cmdline cmdline/cmdline.tcl
getpackage fileutil fileutil/fileutil.tcl
getpackage textutil::repeat textutil/repeat.tcl
getpackage doctools doctools/doctools.tcl
getpackage doctools::toc doctools/doctoc.tcl
getpackage doctools::idx doctools/docidx.tcl
getpackage dtplite dtplite/dtplite.tcl
# Read installation information. Need the list of excluded
# modules to suppress them here in the doc generation as well.
global excluded modules apps guide
source support/installation/modules.tcl
lappend baseconfig -module tcllib
foreach e $excluded {
puts "Excluding $e ..."
lappend baseconfig -exclude */modules/$e/*
}
set nav ../../../../home
puts "Reindex the documentation..."
sak::doc::imake __dummy__
sak::doc::index __dummy__
puts "Removing old documentation..."
# but keep the main index around, manually created, edited, not to be touched
# TODO: catch errors and restore automatically
file rename embedded/index.html e_index.html
file delete -force embedded
file mkdir embedded/www
# Put the saved main page back into place, early.
file rename e_index.html embedded/index.html
file delete -force idoc
file mkdir idoc/man
file mkdir idoc/www
puts "Generating manpages (installation)..."
set config $baseconfig
lappend config -exclude {*/doctools/tests/*}
lappend config -exclude {*/support/*}
lappend config -ext n
lappend config -o idoc/man
lappend config nroff .
dtplite::do $config
# Note: Might be better to run them separately.
# Note @: Or we shuffle the results a bit more in the post processing stage.
set map {
.man .html
modules/ tcllib/files/modules/
apps/ tcllib/files/apps/
}
set toc [string map $map [fileutil::cat support/devel/sak/doc/toc.txt]]
set apps [string map $map [fileutil::cat support/devel/sak/doc/toc_apps.txt]]
set mods [string map $map [fileutil::cat support/devel/sak/doc/toc_mods.txt]]
set cats [string map $map [fileutil::cat support/devel/sak/doc/toc_cats.txt]]
puts "Generating HTML (installation)... Pass 1, draft..."
set config $baseconfig
lappend config -exclude {*/doctools/tests/*}
lappend config -exclude {*/support/*}
lappend config -toc $toc
lappend config -nav {Tcllib Home} $nav
lappend config -post+toc Categories $cats
lappend config -post+toc Modules $mods
lappend config -post+toc Applications $apps
lappend config -merge
lappend config -o idoc/www
lappend config html .
dtplite::do $config
puts "Generating HTML (installation)... Pass 2, resolving cross-references..."
dtplite::do $config
puts "Generating HTML (online)... Pass 1, draft..."
set config $baseconfig
lappend config -exclude {*/doctools/tests/*}
lappend config -exclude {*/support/*}
lappend config -toc $toc
lappend config -post+toc Categories $cats
lappend config -post+toc Modules $mods
lappend config -post+toc Applications $apps
lappend config -merge
lappend config -raw
lappend config -o embedded/www
lappend config -header support/fossil-nav-integration.html
lappend config html .
dtplite::do $config
puts "Generating HTML (online)... Pass 2, resolving cross-references..."
dtplite::do $config
return
}
# ### ### ### ######### ######### #########
package provide sak::localdoc 1.0
##
# ###
|
