Artifact 0292fa9597182dd418aa2b16f6b3e0244c98c24f:
- File modules/doctools/api_toc.tcl — part of check-in [3cefbb6b9b] at 2003-03-05 06:50:33 on branch trunk — * A examples/doctools.idx: Fairly extensive revamping of the * A examples/doctools.toc: codebase. Added a format for * A mpformats/_idx_common.tcl: indices, formatting engines, a * A mpformats/_toc_common.tcl: package for handling it. Extended * A mpformats/idx.html: all packages to allow engine * A mpformats/idx.nroff: parameters and mapping from * A mpformats/idx.null: symbolic to actual filenames or * A mpformats/idx.wiki: urls. Right now only the HTML * A mpformats/toc.html: engines actually provide * A mpformats/toc.nroff: parameters. Added testsuites for * A mpformats/toc.null: doctoc and docidx. Revamped the * A mpformats/toc.tmml: documentation to cross-reference * A mpformats/toc.wiki: each other better, more uniform in * A api_idx.tcl: structure (not complete), naming of * A api_toc.tcl: the manpages for this module is now * A checker_idx.tcl: uniform. Added examples for doctoc * A checker_toc.tcl: and docidx formats, both in the * A docidx.man: manpages, and as separate files. * A docidx.tcl: * A docidx.test: * A docidx_api.man: * A docidx_fmt.man: * A doctoc.man: * A doctoc.tcl: * A doctoc.test: * A doctoc_api.man: * A doctoc_fmt.man: * A doctools_api.man: * A doctools_fmt.man: * A tocexpand: * M ChangeLog: * M NOTES: * M api.tcl: * M checker.tcl: * M doctools.man: * M doctools.tcl: * M doctools.test: * M pkgIndex.tcl: * M mpformats/_common.tcl: * M mpformats/_nroff.tcl: * M mpformats/c.msg: * M mpformats/de.msg: * M mpformats/en.msg: * M mpformats/fmt.html: * M mpformats/fmt.latex: * M mpformats/fmt.list: * R dtformat.man: * R dtformatter.man: (user: andreas_kupries size: 994)
# -*- tcl -*- # api_toc.tcl -- API placeholders # # Copyright (c) 2003 Andreas Kupries <[email protected]> ################################################################ # This file defines all commands expected from a doctoc formatter by the # doctools library. It is loaded into the formatter interpreter before # the code for a particular doctoc format is loaded. All commands defined # here return an error. This ensures the generation of errors if a # format forgets to define commands in the API. ################################################################ # Here it comes foreach __cmd { toc_initialize toc_shutdown toc_setup toc_numpasses toc_listvariables toc_varset fmt_toc_begin fmt_toc_end fmt_division_start fmt_division_end fmt_item fmt_comment fmt_plain_text } { proc $__cmd {args} [list return "return -code error \"Unimplemented API command $__cmd\""] } unset __cmd ################################################################