NAME¶
doctools_lang_faq - doctools language faq
DESCRIPTION¶
OVERVIEW¶
WHAT IS THIS DOCUMENT?¶
This document is currently mainly a placeholder, to be filled with commonly
asked questions about the doctools markup language and companions, and their
answers.
Please report any questions (and, if possible, answers) we should consider for
this document as explained in the section
Bugs, Ideas, Feedback below.
EXAMPLES¶
We have no direct examples of documents written using doctools markup. However
the doctools processor
dtplite does generate a table of contents when
processing a set of documents written in doctools markup. The intermediate
file for it uses doctools markup and is not deleted when generation completes.
Such files can therefore serve as examples.
dtplite is distributed as part of Tcllib, so to get it you need one of
- [1]
- A snapshot of Tcllib. How to retrieve such a snapshot and the tools
required for this are described at Development Snapshots
[/wiki?name=Development+Snapshots]
- [2]
- A Tcllib release archive. They are available at the home [/home]
page.
BUGS, IDEAS, FEEDBACK¶
This document, and the package it describes, will undoubtedly contain bugs and
other problems. Please report such in the category
doctools of the
Tcllib Trackers [
http://core.tcl.tk/tcllib/reportlist]. Please also
report any ideas for enhancements you may have for either package and/or
documentation.
SEE ALSO¶
doctools_lang_cmdref, doctools_lang_intro, doctools_lang_syntax
KEYWORDS¶
doctools commands, doctools language, doctools markup, doctools syntax,
examples, faq, markup, semantic markup
CATEGORY¶
Documentation tools
COPYRIGHT¶
Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>