Scroll to navigation

docidx_lang_faq(3tcl) Documentation tools docidx_lang_faq(3tcl) 





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 as explained in the section Bugs, Ideas,
    Feedback below.








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 a table
    of contents when processing a set of documents written in doctools markup.
    The intermediate file for it uses docidx 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.


When proposing code changes, please provide unified diffs,
    i.e the output of diff -u.


Note further that attachments are strongly preferred over
    inlined patches. Attachments can be made by going to the Edit form of
    the ticket immediately after its creation, and then using the left-most
    button in the secondary navigation bar.






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






CATEGORY


Documentation tools






COPYRIGHT


Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>








  

    1.0
    tcllib