[//000000001]: # (doctools::idx::parse \- Documentation tools) [//000000002]: # (Generated from file 'idx\_parse\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Andreas Kupries ) [//000000004]: # (doctools::idx::parse\(n\) 1 tcllib "Documentation tools")
[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]
# NAME doctools::idx::parse \- Parsing text in docidx format # Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [API](#section2) - [Parse errors](#section3) - [\[docidx\] notation of keyword indices](#section4) - [Keyword index serialization format](#section5) - [Bugs, Ideas, Feedback](#section6) - [Keywords](#keywords) - [Category](#category) - [Copyright](#copyright) # SYNOPSIS 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*](#1) [__::doctools::idx::parse__ __file__ *path*](#2) [__::doctools::idx::parse__ __includes__](#3) [__::doctools::idx::parse__ __include add__ *path*](#4) [__::doctools::idx::parse__ __include remove__ *path*](#5) [__::doctools::idx::parse__ __include clear__](#6) [__::doctools::idx::parse__ __vars__](#7) [__::doctools::idx::parse__ __var set__ *name* *value*](#8) [__::doctools::idx::parse__ __var unset__ *name*](#9) [__::doctools::idx::parse__ __var clear__ ?*pattern*?](#10) # DESCRIPTION This package provides commands to parse text written in the *[docidx](\.\./\.\./\.\./\.\./index\.md\#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](#section5) for specification of their format\. This is an internal package of doctools, for use by the higher level packages handling *[docidx](\.\./\.\./\.\./\.\./index\.md\#docidx)* documents\. # API - __::doctools::idx::parse__ __text__ *text* The command takes the string contained in *text* and parses it under the assumption that it contains a document written using the *[docidx](\.\./\.\./\.\./\.\./index\.md\#docidx)* markup language\. An error is thrown if this assumption is found to be false\. The format of these errors is described in section [Parse errors](#section3)\. When successful the command returns the canonical serialization of the keyword index which was encoded in the text\. See the section [Keyword index serialization format](#section5) for specification of that format\. - __::doctools::idx::parse__ __file__ *path* The same as __text__, except that the text to parse is read from the file specified by *path*\. - __::doctools::idx::parse__ __includes__ This method returns the current list of search paths used when looking for include files\. - __::doctools::idx::parse__ __include add__ *path* This method adds the *path* to the list of paths searched when looking for an include file\. The call is ignored if the path is already in the list of paths\. The method returns the empty string as its result\. - __::doctools::idx::parse__ __include remove__ *path* This method removes the *path* from the list of paths searched when looking for an include file\. The call is ignored if the path is not contained in the list of paths\. The method returns the empty string as its result\. - __::doctools::idx::parse__ __include clear__ This method clears the list of search paths for include files\. - __::doctools::idx::parse__ __vars__ This method returns a dictionary containing the current set of predefined variables known to the __vset__ markup command during processing\. - __::doctools::idx::parse__ __var set__ *name* *value* This method adds the variable *name* to the set of predefined variables known to the __vset__ markup command during processing, and gives it the specified *value*\. The method returns the empty string as its result\. - __::doctools::idx::parse__ __var unset__ *name* This method removes the variable *name* from the set of predefined variables known to the __vset__ markup command during processing\. The method returns the empty string as its result\. - __::doctools::idx::parse__ __var clear__ ?*pattern*? This method removes all variables matching the *pattern* from the set of predefined variables known to the __vset__ markup command during processing\. The method returns the empty string as its result\. The pattern matching is done with __string match__, and the default pattern used when none is specified, is __\*__\. # Parse errors The format of the parse error messages thrown when encountering violations of the *[docidx](\.\./\.\./\.\./\.\./index\.md\#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\. 1. 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\. 1) 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\. 1) The line the first character after the error is on\. Lines are counted from one\. 1) The column the first character after the error is at\. Columns are counted from zero\. 1) 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](\.\./doctools2base/tcllib\_msgcat\.md)__\)\. 1) 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](\.\./doctools/docidx\_lang\_intro\.md)* and then proceed from there to the formal specifications, i\.e\. the documents 1. *[docidx language syntax](\.\./doctools/docidx\_lang\_syntax\.md)* and 1. *[docidx language command reference](\.\./doctools/docidx\_lang\_cmdref\.md)*\. 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*\. - regular serialization 1. An index serialization is a nested Tcl dictionary\. 1. This dictionary holds a single key, __doctools::idx__, and its value\. This value holds the contents of the index\. 1. The contents of the index are a Tcl dictionary holding the title of the index, a label, and the keywords and references\. The relevant keys and their values are * __title__ The value is a string containing the title of the index\. * __label__ The value is a string containing a label for the index\. * __keywords__ The value is a Tcl dictionary, using the keywords known to the index as keys\. The associated values are lists containing the identifiers of the references associated with that particular keyword\. Any reference identifier used in these lists has to exist as a key in the __references__ dictionary, see the next item for its definition\. * __references__ The value is a Tcl dictionary, using the identifiers for the references known to the index as keys\. The associated values are 2\-element lists containing the type and label of the reference, in this order\. Any key here has to be associated with at least one keyword, i\.e\. occur in at least one of the reference lists which are the values in the __keywords__ dictionary, see previous item for its definition\. 1. The *[type](\.\./\.\./\.\./\.\./index\.md\#type)* of a reference can be one of two values, * __manpage__ The identifier of the reference is interpreted as symbolic file name, referring to one of the documents the index was made for\. * __url__ The identifier of the reference is interpreted as an url, referring to some external location, like a website, etc\. - canonical serialization The canonical serialization of a keyword index has the format as specified in the previous item, and then additionally satisfies the constraints below, which make it unique among all the possible serializations of the keyword index\. 1. The keys found in all the nested Tcl dictionaries are sorted in ascending dictionary order, as generated by Tcl's builtin command __lsort \-increasing \-dict__\. 1. The references listed for each keyword of the index, if any, are listed in ascending dictionary order of their *labels*, as generated by Tcl's builtin command __lsort \-increasing \-dict__\. # 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\. # KEYWORDS [docidx](\.\./\.\./\.\./\.\./index\.md\#docidx), [doctools](\.\./\.\./\.\./\.\./index\.md\#doctools), [lexer](\.\./\.\./\.\./\.\./index\.md\#lexer), [parser](\.\./\.\./\.\./\.\./index\.md\#parser) # CATEGORY Documentation tools # COPYRIGHT Copyright © 2009 Andreas Kupries