Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Switch embedded docs over to markdown. Drop lots of superfluous trailing whitespace. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | doc-fixup-and-markdown-localdoc |
Files: | files | file ages | folders |
SHA3-256: |
56ca2fa4d9e0dcb99a6ce795a998352e |
User & Date: | andreask 2019-03-19 18:40:50.666 |
Context
2019-03-20
| ||
23:39 | Merge latest work done on markdown generator (tocs, xrefs). check-in: 945be77637 user: aku tags: doc-fixup-and-markdown-localdoc | |
2019-03-19
| ||
18:40 | Switch embedded docs over to markdown. Drop lots of superfluous trailing whitespace. check-in: 56ca2fa4d9 user: andreask tags: doc-fixup-and-markdown-localdoc | |
05:43 | Markdown continued polishing. - Hook into generation of copyright block. - Force line break in copyright block. - Use entity for copyright symbol. - Fix missing formatting for various span-level markup. - Fix index references, want links, not anchors. - Made notes of missing things (xref mainly, see HTML) - Fixed test results to match Text - Fixed missing cleanup of current context between pages. - Additional guards to detect contexts early, on emission, instead of final render. check-in: 34f227b45f user: aku tags: doc-fixup-and-markdown | |
Changes
Changes to embedded/index.html.
1 2 3 4 5 6 7 8 9 | <div class='fossil-doc' data-title='Tcl Library Source Code'> <h1 align="center">Tcl Library Source Code</h1> <center> <form action='../../../docsrch' method='GET'> <input type="text" name="s" size="40" autofocus> <input type="submit" value="Search Docs"> </form> | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | <div class='fossil-doc' data-title='Tcl Library Source Code'> <h1 align="center">Tcl Library Source Code</h1> <center> <form action='../../../docsrch' method='GET'> <input type="text" name="s" size="40" autofocus> <input type="submit" value="Search Docs"> </form> <p><a href="md/toc.md"> Table Of Contents</a> <a href="md/index.md"> Keyword Index</a> </center> <h2>Discussion & Contact</h2> <ul> <p>Tcllib has two <a href="https://sourceforge.net/p/tcllib/mailman/">mailing lists</a>, one for notifications, the other for general discussion. These are managed at SourceForge, |
︙ | ︙ |
Changes to support/devel/sak/localdoc/localdoc.tcl.
︙ | ︙ | |||
43 44 45 46 47 48 49 | sak::doc::imake __dummy__ $excluded sak::doc::index __dummy__ $excluded 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 | | | > > > > > > > > > > > > | | 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 | sak::doc::imake __dummy__ $excluded sak::doc::index __dummy__ $excluded 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 run-idoc-man $baseconfig # 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]] run-idoc-www $baseconfig $toc $nav $cats $mods $apps set map { .man .md 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]] run-embedded $baseconfig $toc $cats $mods $apps return } proc ::sak::localdoc::run-idoc-man {baseconfig} { file delete -force idoc file mkdir idoc/man file mkdir idoc/www |
︙ | ︙ | |||
91 92 93 94 95 96 97 | dtplite::do $config return } proc ::sak::localdoc::run-idoc-www {baseconfig toc nav cats mods apps} { puts "Generating HTML (installation)... Pass 1, draft..." set config $baseconfig | | | | | | | | | | | | | | | | < | < | | | 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 | dtplite::do $config return } proc ::sak::localdoc::run-idoc-www {baseconfig toc nav cats mods apps} { 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 return } proc ::sak::localdoc::run-embedded {baseconfig toc cats mods apps} { puts "Generating Markdown (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 -o embedded/md lappend config markdown . dtplite::do $config puts "Generating Markdown (online)... Pass 2, resolving cross-references..." dtplite::do $config return } # ### ### ### ######### ######### ######### package provide sak::localdoc 1.0 ## # ### |