Tcl Library Source Code

Documentation
Login


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

NAME

doctools::toc::structure - Doctoc serialization utilities

Table Of Contents

SYNOPSIS

package require doctools::toc::structure ?0.2?
package require Tcl 8.5 9
package require logger
package require snit

::doctools::toc::structure verify serial ?canonvar?
::doctools::toc::structure verify-as-canonical serial
::doctools::toc::structure canonicalize serial
::doctools::toc::structure print serial
::doctools::toc::structure merge seriala serialb

DESCRIPTION

This package provides commands to work with the serializations of tables of contents as managed by the doctools system v2, and specified in section ToC serialization format.

This is an internal package of doctools, for use by the higher level packages handling tables of contents and their conversion into and out of various other formats, like documents written using doctoc markup.

API

ToC serialization format

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

We distinguish between regular and canonical serializations. While a table of contents 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, doctoc, doctools, serialization

CATEGORY

Documentation tools

COPYRIGHT

Copyright © 2009 Andreas Kupries