TMML | Overview | FAQ
Q: How do I create changebars like in the Tcl man pages?
Many elements take a
The nroff-to-TMML up-converter does its best to change
Q: What advantages do you see in using TMML over the more general-purpose DocBook?
The main one is that TMML is custom-designed for Tcl and Tk
reference manuals. It "knows" about things like the
"STANDARD OPTIONS" and "WIDGET-SPECIFIC OPTIONS" sections
of widget manpages, has a richer set of Tcl-specific
semantic elements, and enforces certain conventions
for how manpages are organized.
Q: How about extending DocBook?
A: Sure, why not?
Steve Ball has developed a DocBook customization layer for the
TclDOM project; see
I didn't go this route because TMML was initially designed as a target for converting the existing NROFF documentation into XML. The up-converter works in several stages, adding additional structure and inferring semantics at various stages. As soon as I got to a form that had a high enough "information potential" to faithfully downtranslate to useful presentation forms (i.e., the current HTML rendition), I stopped. Pushing it up one more level to DocBook is certainly doable, but I didn't see the need.
Q: Is there a way to convert the XML into NROFF?
Q: How about Windows Help?
Q: Does TMML support tables?
A: There is no general-purpose, HTML-style table element, but the xl (extended list) element may be used for simple multi-column tables.
Q: How about hardcopy?
A: I've had pretty good luck with tmml2man and groff -man -Tps. If there is a demand for it (or if I get an itch to learn XSL-FO :-), an XSL based formatter is also a possibility.
Q: tmml-man.tcl isn't generating any output. What's wrong?
A: Make sure you have version 2.0 or later of TclXML installed (or tDOM). I've had several reports of this problem occurring with TclXML 1.7
Q: How do I change the HTML footers?
A: The following XSLT parameters can be used to customize the HTML output by specifying them on the SAXON command line:
Q: How do I validate TMML documents?
A: I use the following:
nsgmls -m $TMML_DIR/catalog -sB *.tmml
The trick is to not include <!DOCTYPE ...> declarations in the XML source, but instead to set
FEATURES IMPLYDEF DOCTYPE YESin the SGML declaration and
DOCTYPE manpage tmml.dtd DOCTYPE manual tmml.dtdin the catalog file.
TMML comes with a suitable SGML declaration and catalog file; tmml validate file.tmml invokes nsgmls with the right options.
|Last updated: 28 Apr 2003|