Tcl Library Source Code

Documentation
Login
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.


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

NAME

doctools::idx::structure - Docidx serialization utilities

Table Of Contents

SYNOPSIS

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

DESCRIPTION

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.

API

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.

KEYWORDS

deserialization, docidx, doctools, serialization

CATEGORY

Documentation tools

COPYRIGHT

Copyright © 2009 Andreas Kupries