Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Markdown: Implemented section cross references, per-page TOC. Updated test results. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | doc-fixup-and-markdown |
Files: | files | file ages | folders |
SHA3-256: |
78d88166a8299785eb2c44d3788b1905 |
User & Date: | aku 2019-03-20 05:31:45.470 |
Context
2019-03-20
| ||
22:57 | Markdown: Implemented document cross references, and added refs to the per-page synopses. check-in: a8b930a4d3 user: aku tags: doc-fixup-and-markdown | |
05:31 | Markdown: Implemented section cross references, per-page TOC. Updated test results. check-in: 78d88166a8 user: aku tags: doc-fixup-and-markdown | |
03:51 | Markdown: Fixed indenting of example sections (as code blocks) nested in lists. Updated test results. check-in: 5ea283171a user: aku tags: doc-fixup-and-markdown | |
Changes
Changes to modules/doctools/mpformats/_common.tcl.
︙ | ︙ | |||
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | ###################################################################### # Cross-reference tracking (for a single file). # global SectionNames ;# array mapping 'section name' to 'reference id' global SectionList ;# List of sections, their ids, and levels, in set SectionList {} ;# order of definition. # sectionId -- # Format section name as an XML ID. # proc c_sectionId {name} { # Identical to '__sid' in checker.tcl regsub -all {[ ]+} [string tolower [string trim $name]] _ id regsub -all {"} $id _ id ; # " return $id } | > > > > > > > > > > | | 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 | ###################################################################### # Cross-reference tracking (for a single file). # global SectionNames ;# array mapping 'section name' to 'reference id' global SectionList ;# List of sections, their ids, and levels, in set SectionList {} ;# order of definition. proc c_sections {} { global SectionList set SectionList } proc c_sectionKnown {id} { global SectionNames info exists SectionNames($id) } # sectionId -- # Format section name as an XML ID. # proc c_sectionId {name} { # Identical to '__sid' in checker.tcl regsub -all {[ ]+} [string tolower [string trim $name]] _ id regsub -all {"} $id _ id ; # " return $id } # possibleReference text gi -- # Check if $text is a potential cross-reference; # if so, format as a reference; # otherwise format as a $gi element. # proc c_possibleReference {text gi {label {}}} { global SectionNames |
︙ | ︙ |
Changes to modules/doctools/mpformats/_markdown.tcl.
︙ | ︙ | |||
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | upvar 1 $lb lines lappend lines "#### $title" return } proc Strong {text} { return __${text}__ } proc Em {text} { return *${text}* } set __comments 0 proc MDComment {text} { global __comments Text "\n\[//[format %09d [incr __comments]]\]: # ($text)" } proc MDCDone {} { TextTrimLeadingSpace CloseParagraph [Verbatim] } ## # # ## ### ##### ######## return | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | upvar 1 $lb lines lappend lines "#### $title" return } proc Strong {text} { return __${text}__ } proc Em {text} { return *${text}* } ## # # ## ### ##### ######## ## set __comments 0 proc MDComment {text} { global __comments Text "\n\[//[format %09d [incr __comments]]\]: # ($text)" } proc MDCDone {} { TextTrimLeadingSpace CloseParagraph [Verbatim] } ## # # ## ### ##### ######## ## proc ALink {dst label} { return "\[$label]($dst)" } proc SetAnchor {text {name {}}} { if {$name == {}} { set name [Anchor $text] } return "<a name='$name'></a>$text" } proc Anchor {text} { global kwid if {[info exists kwid($text)]} { return "$kwid($text)" } return [A $text] } proc A {text} { set anchor [regsub -all {[^a-zA-Z0-9]} [string tolower $text] {_}] set anchor [regsub -all {__+} $anchor _] return $anchor } ## # # ## ### ##### ######## return |
Changes to modules/doctools/mpformats/fmt.html.
︙ | ︙ | |||
225 226 227 228 229 230 231 | c_newSection {Table Of Contents} 1 0 toc if {[llength [c_xref_seealso]] > 0} {c_newSection {See Also} 1 end see-also} if {[llength [c_xref_keywords]] > 0} {c_newSection Keywords 1 end keywords} if {[c_xref_category] ne ""} {c_newSection Category 1 end category} if {[c_get_copyright] != {}} {c_newSection Copyright 1 end copyright} | | | | 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 | c_newSection {Table Of Contents} 1 0 toc if {[llength [c_xref_seealso]] > 0} {c_newSection {See Also} 1 end see-also} if {[llength [c_xref_keywords]] > 0} {c_newSection Keywords 1 end keywords} if {[c_xref_category] ne ""} {c_newSection Category 1 end category} if {[c_get_copyright] != {}} {c_newSection Copyright 1 end copyright} set sections [c_sections] # Pass 2: Generate the markup for the TOC, indenting the # links according to the level of each section. append result [fmt_section {Table Of Contents} toc] [para_close] \n append result [taga ul {class doctools_toc}] \n set lastlevel 1 set close 0 foreach {name id level} $sections { # level in {1,2}, 1 = section, 2 = subsection if {$level == $lastlevel} { # Close previous item. if {$close} { append result [tag/ li] \n } } elseif {$level > $lastlevel} { # Start list of subsections append result \n [tag ul] \n } else { # level < lastlevel |
︙ | ︙ | |||
365 366 367 368 369 370 371 | proc fmt_arg {text} { italic $text arg } proc fmt_cmd {text} { bold [XrefMatch $text sa] cmd } proc fmt_emph {text} { em $text } proc fmt_opt {text} { span "?$text?" opt } proc fmt_comment {text} {ht_comment $text} proc fmt_sectref {title {id {}}} { | < | < | | | 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | proc fmt_arg {text} { italic $text arg } proc fmt_cmd {text} { bold [XrefMatch $text sa] cmd } proc fmt_emph {text} { em $text } proc fmt_opt {text} { span "?$text?" opt } proc fmt_comment {text} {ht_comment $text} proc fmt_sectref {title {id {}}} { if {$id == {}} { set id [c_sectionId $title] } if {[c_sectionKnown $id]} { return [span [link $title "#$id"] sectref] } else { return [bold $title sectref] } } proc fmt_syscmd {text} {bold [XrefMatch $text sa] syscmd} |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.markdown.
1 2 3 4 5 6 7 8 9 | # -*- tcl -*- # Convert a doctools document into markdown formatted text # # Copyright (c) 2019 Andreas Kupries <[email protected]> # Note: While markdown is a text format its intended target is HTML, # making its formatting nearer to that with the ability to set anchors # and refer to them, linkage in general. | < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | # -*- tcl -*- # Convert a doctools document into markdown formatted text # # Copyright (c) 2019 Andreas Kupries <[email protected]> # Note: While markdown is a text format its intended target is HTML, # making its formatting nearer to that with the ability to set anchors # and refer to them, linkage in general. # TODO: Synopsis command linkage # TODO: package - xref # TODO: syscmd - xref # TODO: cmd - xref # TODO: term -xref # TODO: see also, keywords - xref |
︙ | ︙ | |||
158 159 160 161 162 163 164 165 166 167 168 169 170 171 | TD $term $def ContextCommit ContextPop ContextSet $base return } c_pass 1 fmt_usage {cmd args} {c_hold synopsis "[join [linsert $args 0 $cmd] " "][LB.]"} c_pass 1 fmt_call {cmd args} {c_hold synopsis "[join [linsert $args 0 $cmd] " "][LB.]"} c_pass 1 fmt_require {pkg {version {}}} { set result "package require $pkg" if {$version != {}} {append result " $version"} c_hold require "$result " | > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | TD $term $def ContextCommit ContextPop ContextSet $base return } ## # # ## ### ##### ######## ## c_pass 1 fmt_section {name id} { c_newSection $name 1 end $id } c_pass 2 fmt_section {name id} { CloseParagraph Section [SetAnchor $name $id] return } c_pass 1 fmt_subsection {name id} { c_newSection $name 2 end $id } c_pass 2 fmt_subsection {name id} { CloseParagraph Subsection [SetAnchor $name $id] return } proc fmt_sectref {title {id {}}} { if {$id == {}} { set id [c_sectionId $title] } if {[c_sectionKnown $id]} { return [ALink "#$id" $title] } else { return [Strong $title] } } c_pass 1 fmt_usage {cmd args} {c_hold synopsis "[join [linsert $args 0 $cmd] " "][LB.]"} c_pass 1 fmt_call {cmd args} {c_hold synopsis "[join [linsert $args 0 $cmd] " "][LB.]"} c_pass 1 fmt_require {pkg {version {}}} { set result "package require $pkg" if {$version != {}} {append result " $version"} c_hold require "$result " |
︙ | ︙ | |||
183 184 185 186 187 188 189 | proc fmt_arg {text} { Em $text } proc fmt_cmd {text} { Strong $text } proc fmt_method {text} { Strong $text } proc fmt_option {text} { Strong $text } proc fmt_uri {text {label {}}} { if {$label == {}} { set label $text } | | | 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | proc fmt_arg {text} { Em $text } proc fmt_cmd {text} { Strong $text } proc fmt_method {text} { Strong $text } proc fmt_option {text} { Strong $text } proc fmt_uri {text {label {}}} { if {$label == {}} { set label $text } ALink $text $label } proc fmt_image {text {label {}}} { # text = symbolic name of the image. # formatting based on the available data ... |
︙ | ︙ | |||
214 215 216 217 218 219 220 | CloseCurrent } } return $img } | < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > | 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 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | CloseCurrent } } return $img } c_pass 2 fmt_manpage_begin {title section version} { Off set module [dt_module] set shortdesc [c_get_module] set description [c_get_title] MDComment "$title - $shortdesc" MDComment [c_provenance] MDComment "[string trimleft $title :]($section) $version $module \"$shortdesc\"" MDCDone Section NAME Text "$title - $description" CloseParagraph return } c_pass 2 fmt_description {id} { On set syn [c_held synopsis] set req [c_held require] # Create the TOC. # Pass 1: We have a number of special sections which were not # listed explicitly in the document sources. Add them # now. Note the inverse order for the sections added # at the beginning. c_newSection Description 1 0 $id if {$syn != {} || $req != {}} {c_newSection Synopsis 1 0 synopsis} c_newSection {Table Of Contents} 1 0 toc if {[llength [c_xref_seealso]] > 0} {c_newSection {See Also} 1 end see-also} if {[llength [c_xref_keywords]] > 0} {c_newSection Keywords 1 end keywords} if {[c_xref_category] ne ""} {c_newSection Category 1 end category} if {[c_get_copyright] != {}} {c_newSection Copyright 1 end copyright} # Pass 2: Generate the markup for the TOC, indenting the # links according to the level of each section. TOC # Implicit sections coming after the TOC (Synopsis, then the # description which starts the actual document). The other # implicit sections are added at the end of the document and are # generated by 'fmt_manpage_end' in the second pass. if {$syn != {} || $req != {}} { Section [SetAnchor SYNOPSIS synopsis] if {($req != {}) && ($syn != {})} { Text $req\n\n$syn } else { if {$req != {}} {Text $req} if {$syn != {}} {Text $syn} } CloseParagraph [Verbatim] } Section [SetAnchor DESCRIPTION description] return } c_pass 2 fmt_manpage_end {} { set sa [c_xref_seealso] set kw [c_xref_keywords] set ca [c_xref_category] set ct [c_get_copyright] CloseParagraph if {[llength $sa]} { Special {SEE ALSO} see-also [join [lsort $sa] ", "] } if {[llength $kw]} { Special KEYWORDS keywords [join [lsort $kw] ", "] } if {$ca ne ""} { Special CATEGORY category $ca } if {$ct != {}} { Special COPYRIGHT copyright $ct [Verbatim] } return } proc c_get_copyright {} { return [join [c_get_copyright_r] [LB]] } ## # # ## ### ##### ######## ## proc Special {title id text {p {}}} { Section [SetAnchor $title $id] Text $text CloseParagraph $p } proc TOC {} { # While we could go through (fmt_list_begin itemized, item ..., # fmt_list_end) it looks to be easier to directly emit paragraphs # into the display list. No need to track anything. Just map entry # level directly to the proper context. Section [SetAnchor {Table Of Contents} toc] ContextPush lappend toc _bogus_ lappend toc [ContextNew TOC/Section { List! bullet " - " " " }] lappend toc [ContextNew TOC/SubSect { List! bullet " - " " " }] ContextPop foreach {name id level} [c_sections] { # level in {1,2}, 1 = section, 2 = subsection Text [ALink "#$id" $name] CloseParagraph [lindex $toc $level] } return } ## # # ## ### ##### ######## return |
Changes to modules/doctools/mpformats/idx.markdown.
︙ | ︙ | |||
154 155 156 157 158 159 160 | } proc Separator {} { Text ---- CloseParagraph [Verbatim] } | < < < < < < < < < < < < < < < < < < < < < | 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | } proc Separator {} { Text ---- CloseParagraph [Verbatim] } # ### ### ### ######### ######### ######### ## Engine state proc LoadKwid {} { global kwid # Engine parameter - load predefined keyword anchors. set ki [Get kwid] |
︙ | ︙ |
Changes to modules/doctools/tests/fmt/markdown/00.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > > > > > > > > | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/01.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > > > > > > > > | | | 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 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION Argument ::*Argument*:: Class ::__Class__:: Command ::__Command__:: Comment :::: Const ::__Constant__:: Emphasis ::*Emphasis*:: File ::"File/Path":: Function ::__Function__:: Method ::__Method__:: Namespace ::__Namespace__:: Option ::__Option__:: Optional ::?Optional?:: Package ::__Package__:: Syscmd ::__SystemCommand__:: Term ::*Term*:: Type ::__Type__:: Uri ::[Uri](Uri):: Variable ::__Variable__:: Widget ::__Widget__:: # <a name='copyright'></a>COPYRIGHT Copyright © **Copyright** |
Changes to modules/doctools/tests/fmt/markdown/02.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ..THE_MODULE..) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "..THE_MODULE..") # NAME TEST - ..THE_TITLE.. | > > > > > > > > > > > > > > | | | | | | 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 | [//000000001]: # (TEST - ..THE_MODULE..) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "..THE_MODULE..") # NAME TEST - ..THE_TITLE.. # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [See Also](#see-also) - [Keywords](#keywords) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require AAA package require BBB VVV # <a name='description'></a>DESCRIPTION # <a name='see-also'></a>SEE ALSO ELSE, OTHER # <a name='keywords'></a>KEYWORDS KEYA, KEYZ # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/03.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > | > > | > > > > > > > > > > > > > > > | | | | | | | | 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 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [AaA](#section2) - [BbB](#section3) - [BbB.cCc](#subsection1) - [BbB.dDd](#subsection2) - [EeE](#section4) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION # <a name='section2'></a>AaA 1 # <a name='section3'></a>BbB 22 ## <a name='subsection1'></a>BbB.cCc 333 ## <a name='subsection2'></a>BbB.dDd 4444 # <a name='section4'></a>EeE 5555 At [AaA](#section2). At ____undefined____. # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/04.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > > > > > > > > | | | 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 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION BEGINNE HIER Example Block More Lines Inlined Example \ Next Line FERTIG # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/05.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (BASIC - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (BASIC(a) 5 .MODULE. "") # NAME BASIC - | > > > > > > > > > > | | | 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 | [//000000001]: # (BASIC - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (BASIC(a) 5 .MODULE. "") # NAME BASIC - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS a-command # <a name='description'></a>DESCRIPTION OK - integer *argument-1* verification |
︙ | ︙ | |||
73 74 75 76 77 78 79 | Database Name: __Foreground__ Database Class: __Color__ caramel KO | | | 83 84 85 86 87 88 89 90 91 92 | Database Name: __Foreground__ Database Class: __Color__ caramel KO # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/06.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > > > > > > > > | | 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 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION - 1 2 3 |
︙ | ︙ | |||
41 42 43 44 45 46 47 | - 4 5 6 | | | 49 50 51 52 53 54 55 56 57 58 | - 4 5 6 # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/07.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > > > > > > > > | | 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 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION - 1 - 2 1. a |
︙ | ︙ | |||
33 34 35 36 37 38 39 | 1. a 22 - 3 | | | 41 42 43 44 45 46 47 48 49 50 | 1. a 22 - 3 # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/08.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (ALL - ..THE_MODULE..) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (ALL(a) 5 .MODULE. "..THE_MODULE..") # NAME ALL - ..THE_TITLE.. | > > > > > > > > > > > > > > > > > > | | | | | 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 | [//000000001]: # (ALL - ..THE_MODULE..) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (ALL(a) 5 .MODULE. "..THE_MODULE..") # NAME ALL - ..THE_TITLE.. # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [API](#section2) - [NARGLE](#subsection1) - [See Also](#see-also) - [Keywords](#keywords) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require AAA package require BBB VVV package require CCC ?VVV? CMDNAME ... CMDNAME ... CMDNAME ... # <a name='description'></a>DESCRIPTION - __NAME__ DESCRIPTION ::__Command__:: - __NAME__ DESCRIPTION :::: - __NAME__ DESCRIPTION ::__Constant__:: # <a name='section2'></a>API - TERM DESCRIPTION ::*Emphasis*:: - TERM DESCRIPTION ::"File/Path":: * Command-Line Switch: __NAME__ Database Name: __DBNAME__ Database Class: __CLASS__ DESCRIPTION [NARGLE](#subsection1) * Command-Line Switch: __NAME__ Database Name: __DBNAME__ Database Class: __CLASS__ DESCRIPTION ::__Function__:: |
︙ | ︙ | |||
98 99 100 101 102 103 104 | DESCRIPTION ::__Type__:: * __NAME__ ARGUMENT DESCRIPTION ::[Uri](Uri):: | | | | | | 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 | DESCRIPTION ::__Type__:: * __NAME__ ARGUMENT DESCRIPTION ::[Uri](Uri):: ## <a name='subsection1'></a>NARGLE 1. PARAGRAPH ::[UriLabel](Uri):: 1. PARAGRAPH ::__Variable__:: 1. PARAGRAPH ::__Widget__:: - PARAGRAPH ::__Class__:: - PARAGRAPH - PARAGRAPH # <a name='see-also'></a>SEE ALSO ELSE, OTHER # <a name='keywords'></a>KEYWORDS KEYA, KEYZ # <a name='copyright'></a>COPYRIGHT Copyright © **Copyright** |
Changes to modules/doctools/tests/fmt/markdown/09.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - | > > > > > > > > | | 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 | [//000000001]: # (TEST - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (TEST(z) 3.14.15.926 .MODULE. "") # NAME TEST - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem 1 lorem ipsum dolores ipsum |
︙ | ︙ | |||
27 28 29 30 31 32 33 | ipsum 5 lorem ipsum dolores dolores | | | 35 36 37 38 39 40 41 42 43 44 | ipsum 5 lorem ipsum dolores dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/10.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-itemized - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-itemized(1) n .MODULE. "") # NAME test-itemized - | > > > > > > > > | | | 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 | [//000000001]: # (test-itemized - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-itemized(1) n .MODULE. "") # NAME test-itemized - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores - lorem ipsum dolores - lorem ipsum dolores lorem ipsum dolores - lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/11.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-enumerated - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-enumerated(1) n .MODULE. "") # NAME test-enumerated - | > > > > > > > > | | | 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 | [//000000001]: # (test-enumerated - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-enumerated(1) n .MODULE. "") # NAME test-enumerated - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores 1. lorem ipsum dolores 1. lorem ipsum dolores lorem ipsum dolores 1. lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/12.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-definitions - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-definitions(1) n .MODULE. "") # NAME test-definitions - | > > > > > > > > | | 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 | [//000000001]: # (test-definitions - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-definitions(1) n .MODULE. "") # NAME test-definitions - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores - lorem ipsum dolores |
︙ | ︙ | |||
25 26 27 28 29 30 31 | ipsum dolores lorem ipsum dolores lorem ipsum dolores | | | 33 34 35 36 37 38 39 40 41 42 | ipsum dolores lorem ipsum dolores lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/13.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-itemized-examples - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-itemized-examples(1) n .MODULE. "") # NAME test-itemized-examples - | > > > > > > > > | | | 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 | [//000000001]: # (test-itemized-examples - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-itemized-examples(1) n .MODULE. "") # NAME test-itemized-examples - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores - A lorem ipsum dolores - lorem ipsum dolores B lorem ipsum dolores lorem ipsum dolores - lorem ipsum dolores C lorem ipsum dolores - lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/14.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-enumerated-examples - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-enumerated-examples(1) n .MODULE. "") # NAME test-enumerated-examples - | > > > > > > > > | | | 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 | [//000000001]: # (test-enumerated-examples - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-enumerated-examples(1) n .MODULE. "") # NAME test-enumerated-examples - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores 1. A1 lorem ipsum dolores 1. lorem ipsum dolores B2 lorem ipsum dolores lorem ipsum dolores 1. lorem ipsum dolores C3 lorem ipsum dolores 1. lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/15.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-definition-examples - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-definition-examples(1) n .MODULE. "") # NAME test-definition-examples - | > > > > > > > > | | 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 | [//000000001]: # (test-definition-examples - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-definition-examples(1) n .MODULE. "") # NAME test-definition-examples - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores - lorem A1 lorem ipsum dolores |
︙ | ︙ | |||
29 30 31 32 33 34 35 | C3 lorem ipsum dolores - lorem ipsum dolores | | | 37 38 39 40 41 42 43 44 45 46 | C3 lorem ipsum dolores - lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/16.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-itemized-nested - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-itemized-nested(1) n .MODULE. "") # NAME test-itemized-nested - | > > > > > > > > | | 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 | [//000000001]: # (test-itemized-nested - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-itemized-nested(1) n .MODULE. "") # NAME test-itemized-nested - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores - lorem ipsum dolores * lorem ipsum dolores |
︙ | ︙ | |||
43 44 45 46 47 48 49 | lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores | | | 51 52 53 54 55 56 57 58 59 60 | lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/17.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-enumerated-nested - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-enumerated-nested(1) n .MODULE. "") # NAME test-enumerated-nested - | > > > > > > > > | | 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 | [//000000001]: # (test-enumerated-nested - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-enumerated-nested(1) n .MODULE. "") # NAME test-enumerated-nested - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores 1. lorem ipsum dolores 1) lorem ipsum dolores |
︙ | ︙ | |||
43 44 45 46 47 48 49 | lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores | | | 51 52 53 54 55 56 57 58 59 60 | lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |
Changes to modules/doctools/tests/fmt/markdown/18.
1 2 3 4 5 6 7 8 9 | [//000000001]: # (test-definitions-nested - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-definitions-nested(1) n .MODULE. "") # NAME test-definitions-nested - | > > > > > > > > | | 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 | [//000000001]: # (test-definitions-nested - ) [//000000002]: # (Generated from file '.FILE.' by tcllib/doctools with format 'markdown') [//000000003]: # (test-definitions-nested(1) n .MODULE. "") # NAME test-definitions-nested - # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION lorem ipsum dolores - lorem ipsum dolores |
︙ | ︙ | |||
61 62 63 64 65 66 67 | lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores | | | 69 70 71 72 73 74 75 76 77 78 | lorem ipsum dolores lorem ipsum dolores lorem ipsum dolores # <a name='copyright'></a>COPYRIGHT Copyright © .COPYRIGHT. |