1docidx_lang_faq(n)            Documentation tools           docidx_lang_faq(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       docidx_lang_faq - docidx language faq
9

DESCRIPTION

OVERVIEW
12   WHAT IS THIS DOCUMENT?
13       This document is currently mainly a placeholder, to be filled with com‐
14       monly asked questions about the docidx markup language and  companions,
15       and their answers.
16
17       Please  report any questions (and, if possible, answers) we should con‐
18       sider for this document as explained in the section Bugs, Ideas,  Feed‐
19       back below.
20

EXAMPLES
22   WHERE DO I FIND DOCIDX EXAMPLES?
23       We  have  no  direct examples of documents written using docidx markup.
24       However the doctools processor dtplite does generate a  table  of  con‐
25       tents  when  processing  a set of documents written in doctools markup.
26       The intermediate file for it uses docidx markup and is not deleted when
27       generation completes. Such files can therefore serve as examples.
28
29       dtplite is distributed as part of Tcllib, so to get it you need one of
30
31       [1]    A  snapshot  of  Tcllib. How to retrieve such a snapshot and the
32              tools required for this are described at  Development  Snapshots
33              [/wiki?name=Development+Snapshots]
34
35       [2]    A Tcllib release archive. They are available at the home [/home]
36              page.
37

BUGS, IDEAS, FEEDBACK
39       This document, and the package it describes, will  undoubtedly  contain
40       bugs  and  other problems.  Please report such in the category doctools
41       of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist].   Please
42       also  report any ideas for enhancements you may have for either package
43       and/or documentation.
44
45       When proposing code changes, please provide unified diffs, i.e the out‐
46       put of diff -u.
47
48       Note  further  that  attachments  are  strongly  preferred over inlined
49       patches. Attachments can be made by going  to  the  Edit  form  of  the
50       ticket  immediately  after  its  creation, and then using the left-most
51       button in the secondary navigation bar.
52

SEE ALSO
54       docidx_lang_cmdref, docidx_lang_intro, docidx_lang_syntax
55

KEYWORDS
57       docidx commands, docidx language, docidx markup, docidx  syntax,  exam‐
58       ples, faq, markup, semantic markup
59

CATEGORY
61       Documentation tools
62

64       Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>
65
66
67
68
69tcllib                                1.0                   docidx_lang_faq(n)



        

    


            
        

        

            Impressum