doctools::idx::structure(3tcl) | Documentation tools | doctools::idx::structure(3tcl) |
doctools::idx::structure - Docidx serialization utilities
package require doctools::idx::structure ?0.1?
package require Tcl 8.4
package require logger
package require snit
::doctools::idx::structure verify serial ?canonvar?
::doctools::idx::structure verify-as-canonical serial
::doctools::idx::structure canonicalize serial
::doctools::idx::structure print serial
::doctools::idx::structure merge seriala serialb
This package provides commands to work with the serializations of keyword indices as managed by the doctools system v2, and specified in section Keyword index serialization format.
This is an internal package of doctools, for use by the higher level packages handling keyword indices and their conversion into and out of various other formats, like documents written using docidx markup.
If the argument canonvar is specified it is interpreted as the name of a variable in the calling context. This variable will be written to if and only if serial is a valid regular serialization. Its value will be a boolean, with True indicating that the serialization is not only valid, but also canonical. False will be written for a valid, but non-canonical serialization.
For the specification of regular and canonical keyword index serializations see the section Keyword index serialization format.
For the specification of canonical keyword index serializations see the section Keyword index serialization format.
It will then convert the input into the canonical serialization of the contained keyword index and return it as its result. If the input is already canonical it will be returned unchanged.
For the specification of regular and canonical keyword index serializations see the section Keyword index serialization format.
The exact format of this form is not specified and cannot be relied on for parsing or other machine-based activities.
For the specification of regular keyword index serializations see the section Keyword index serialization format.
Title and label of the resulting index are taken from the index contained in serialb. The set of keys, references and their connections is the union of the set of keys and references of the two inputs.
For the specification of regular and canonical keyword index serializations see the section 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.
Any reference identifier used in these lists has to exist as a key in the references dictionary, see the next item for its definition.
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.
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.
deserialization, docidx, doctools, serialization
Documentation tools
Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>
0.1 | tcllib |