1[comment {-*- tcl -*- doctools manpage}]
2[manpage_begin docidx_lang_faq n 1.0]
3[copyright {2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
4[moddesc   {Documentation tools}]
5[titledesc {docidx language faq}]
6[category  {Documentation tools}]
7[description]
8[para]
9
10[section OVERVIEW]
11
12[subsection {What is this document?}]
13
14This document is currently mainly a placeholder, to be filled with
15commonly asked questions about the docidx markup language and
16companions, and their answers.
17
18[para]
19
20Please report any questions (and, if possible, answers) we should
21consider for this document in the category [emph doctools] of the
22[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].
23
24[section EXAMPLES]
25
26[subsection {Where do I find docidx examples?}]
27
28We have no direct examples of documents written using docidx
29markup. However the doctools processor [syscmd dtplite] does generate
30keyword indices when processing a set of documents written in doctools
31markup. The intermediate files use docidx markup and are not deleted
32when generation completes. These files can therefore serve as
33examples.
34
35[para]
36
37[syscmd dtplite] is distributed as part of Tcllib, so to get it you
38need one of
39
40[list_begin enumerated]
41
42[enum]
43A CVS snapshot of Tcllib. How to retrieve such a snapshot and the
44tools required for this are described at
45[uri http://sourceforge.net/cvs/?group_id=12883]
46
47[enum]
48A Tcllib release archive. They are available at
49[uri http://sourceforge.net/project/showfiles.php?group_id=12883]
50
51[list_end]
52
53
54
55[section {BUGS, IDEAS, FEEDBACK}]
56
57This document, will undoubtedly contain bugs and other problems.
58
59Please report any such in the category [emph doctools] of the
60[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].
61
62Please also report any ideas for enhancements you may have for either
63the package and/or the documentation.
64
65[see_also docidx_lang_intro]
66[see_also docidx_lang_syntax]
67[see_also docidx_lang_cmdref]
68[keywords examples faq markup {semantic markup}]
69[keywords {docidx markup} {docidx language}]
70[keywords {docidx syntax} {docidx commands}]
71[manpage_end]
72