Tcl Library Source Code

Bounty program for improvements to Tcl and certain Tcl packages.

[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]


doctools::idx::parse - Parsing text in docidx format

Table Of Contents


package require doctools::idx::parse ?0.1?
package require Tcl 8.4
package require doctools::idx::structure
package require doctools::msgcat
package require doctools::tcl::parse
package require fileutil
package require logger
package require snit
package require struct::list
package require struct::stack

::doctools::idx::parse text text
::doctools::idx::parse file path
::doctools::idx::parse includes
::doctools::idx::parse include add path
::doctools::idx::parse include remove path
::doctools::idx::parse include clear
::doctools::idx::parse vars
::doctools::idx::parse var set name value
::doctools::idx::parse var unset name
::doctools::idx::parse var clear ?pattern?


This package provides commands to parse text written in the docidx markup language and convert it into the canonical serialization of the keyword index encoded in the text. See the section Keyword index serialization format for specification of their format.

This is an internal package of doctools, for use by the higher level packages handling docidx documents.


Parse errors

The format of the parse error messages thrown when encountering violations of the docidx markup syntax is human readable and not intended for processing by machines. As such it is not documented.

However, the errorCode attached to the message is machine-readable and has the following format:

  1. The error code will be a list, each element describing a single error found in the input. The list has at least one element, possibly more.

  2. Each error element will be a list containing six strings describing an error in detail. The strings will be

    1. The path of the file the error occurred in. This may be empty.
    2. The range of the token the error was found at. This range is a two-element list containing the offset of the first and last character in the range, counted from the beginning of the input (file). Offsets are counted from zero.
    3. The line the first character after the error is on. Lines are counted from one.
    4. The column the first character after the error is at. Columns are counted from zero.
    5. The message code of the error. This value can be used as argument to msgcat::mc to obtain a localized error message, assuming that the application had a suitable call of doctools::msgcat::init to initialize the necessary message catalogs (See package doctools::msgcat).
    6. A list of details for the error, like the markup command involved. In the case of message code docidx/include/syntax this value is the set of errors found in the included file, using the format described here.

[docidx] notation of keyword indices

The docidx format for keyword indices, also called the docidx markup language, is too large to be covered in single section. The interested reader should start with the document

  1. docidx language introduction

and then proceed from there to the formal specifications, i.e. the documents

  1. docidx language syntax and

  2. docidx language command reference.

to get a thorough understanding of the language.

Keyword index serialization format

Here we specify the format used by the doctools v2 packages to serialize keyword indices as immutable values for transport, comparison, etc.

We distinguish between regular and canonical serializations. While a keyword index may have more than one regular serialization only exactly one of them will be canonical.

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. 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.


docidx, doctools, lexer, parser


Documentation tools


Copyright © 2009 Andreas Kupries