This manual page is for Mac OS X version 10.6

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



docidx_lang_faq(n)                           Documentation tools                          docidx_lang_faq(n)



____________________________________________________________________________________________________________

NAME
       docidx_lang_faq - docidx language faq

DESCRIPTION
OVERVIEW
   WHAT IS THIS DOCUMENT?
       This document is currently mainly a placeholder, to be filled with commonly asked questions about the
       docidx markup language and companions, and their answers.

       Please report any questions (and, if possible, answers) we should consider for this document  in  the
       category doctools of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].

EXAMPLES
   WHERE DO I FIND DOCIDX EXAMPLES?
       We  have  no direct examples of documents written using docidx markup. However the doctools processor
       dtplite does generate keyword indices when processing a set of documents written in doctools  markup.
       The  intermediate  files use docidx markup and are not deleted when generation completes. These files
       can therefore serve as examples.

       dtplite is distributed as part of Tcllib, so to get it you need one of

       [1]    A CVS snapshot of Tcllib. How to retrieve such a snapshot and the tools required for this  are
              described at http://sourceforge.net/cvs/?group_id=12883

       [2]    A   Tcllib   release  archive.  They  are  available  at  http://sourceforge.net/project/show-
              files.php?group_id=12883


BUGS, IDEAS, FEEDBACK
       This document, will undoubtedly contain bugs and other problems.  Please report any such in the cate-gory category
       gory  doctools  of  the  Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].  Please
       also report any ideas for enhancements you may have for either the package and/or the  documentation.

SEE ALSO
       docidx_lang_cmdref, docidx_lang_intro, docidx_lang_syntax

KEYWORDS
       docidx  commands,  docidx  language,  docidx  markup,  docidx syntax, examples, faq, markup, semantic
       markup

COPYRIGHT
       Copyright (c) 2007 Andreas Kupries <[email protected]>




doctools                                             1.0                                  docidx_lang_faq(n)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.