
[//000000001]: # (docidx\_lang\_faq \- Documentation tools)
[//000000002]: # (Generated from file 'docidx\_lang\_faq\.man' by tcllib/doctools with format 'markdown')
[//000000003]: # (Copyright &copy; 2007 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>)
[//000000004]: # (docidx\_lang\_faq\(n\) 1\.0 tcllib "Documentation tools")

<hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> &#124; <a
href="../../../toc.md">Table Of Contents</a> &#124; <a
href="../../../../index.md">Keyword Index</a> &#124; <a
href="../../../../toc0.md">Categories</a> &#124; <a
href="../../../../toc1.md">Modules</a> &#124; <a
href="../../../../toc2.md">Applications</a> ] <hr>

# NAME

docidx\_lang\_faq \- docidx language faq

# <a name='toc'></a>Table Of Contents

  - [Table Of Contents](#toc)

  - [Description](#section1)

  - [OVERVIEW](#section2)

      - [What is this document?](#subsection1)

  - [EXAMPLES](#section3)

      - [Where do I find docidx examples?](#subsection2)

  - [Bugs, Ideas, Feedback](#section4)

  - [See Also](#seealso)

  - [Keywords](#keywords)

  - [Category](#category)

  - [Copyright](#copyright)

# <a name='description'></a>DESCRIPTION

# <a name='section2'></a>OVERVIEW

## <a name='subsection1'></a>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](#section4) below\.

# <a name='section3'></a>EXAMPLES

## <a name='subsection2'></a>Where do I find docidx examples?

We have no direct examples of documents written using docidx markup\. However the
doctools processor __[dtplite](\.\./\.\./apps/dtplite\.md)__ 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](\.\./\.\./apps/dtplite\.md)__ 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)

  1. A Tcllib release archive\. They are available at the [home](/home) page\.

# <a name='section4'></a>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\.

# <a name='seealso'></a>SEE ALSO

[docidx\_lang\_cmdref](docidx\_lang\_cmdref\.md),
[docidx\_lang\_intro](docidx\_lang\_intro\.md),
[docidx\_lang\_syntax](docidx\_lang\_syntax\.md)

# <a name='keywords'></a>KEYWORDS

[docidx commands](\.\./\.\./\.\./\.\./index\.md\#docidx\_commands), [docidx
language](\.\./\.\./\.\./\.\./index\.md\#docidx\_language), [docidx
markup](\.\./\.\./\.\./\.\./index\.md\#docidx\_markup), [docidx
syntax](\.\./\.\./\.\./\.\./index\.md\#docidx\_syntax),
[examples](\.\./\.\./\.\./\.\./index\.md\#examples),
[faq](\.\./\.\./\.\./\.\./index\.md\#faq), [markup](\.\./\.\./\.\./\.\./index\.md\#markup),
[semantic markup](\.\./\.\./\.\./\.\./index\.md\#semantic\_markup)

# <a name='category'></a>CATEGORY

Documentation tools

# <a name='copyright'></a>COPYRIGHT

Copyright &copy; 2007 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>
