Tcl Library Source Code

EuroTcl/OpenACS 11 - 12 JULY 2024, VIENNA

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


doctools::idx::export::json - JSON export plugin

Table Of Contents


package require Tcl 8.5 9
package require doctools::idx::export::json ?0.2?
package require textutil::adjust

export serial configuration


This package implements the doctools keyword index export plugin for the generation of JSON markup.

This is an internal package of doctools, for use by the higher level management packages handling keyword indices, especially doctools::idx::export, the export manager.

Using it from a regular interpreter is possible, however only with contortions, and is not recommended. The proper way to use this functionality is through the package doctools::idx::export and the export manager objects it provides.


The API provided by this package satisfies the specification of the docidx export plugin API version 2.

JSON notation of keyword indices

The JSON format used for keyword indices is a direct translation of the Keyword index serialization format, mapping Tcl dictionaries as JSON objects and Tcl lists as JSON arrays. For example, the Tcl serialization

doctools::idx {
	label {Keyword Index}
	keywords {
		changelog  {}
		conversion { apps/}
	references {
		apps/ {manpage dtplite}    {manpage doctools::changelog}          {manpage doctools::cvs}       {manpage doctools::idx}       {manpage doctools::toc}     {manpage doctools}     {manpage mpexpand}
	title {}

is equivalent to the JSON string

    "doctools::idx" : {
        "label"      : "Keyword Index",
        "keywords"   : {
            "changelog"  : ["",""],
            "conversion" : ["","","","apps\/",""],
            "cvs"        : [""],
        "references" : {
            "apps\/" : ["manpage","dtplite"],
            ""     : ["manpage","doctools::changelog"],
            ""           : ["manpage","doctools::cvs"],
            ""        : ["manpage","doctools::idx"],
            ""        : ["manpage","doctools::toc"],
            ""      : ["manpage","doctools"],
            ""      : ["manpage","mpexpand"]
        "title"      : ""


The JSON export plugin recognizes the following configuration variables and changes its behaviour as they specify.

Note that this plugin ignores the standard configuration variables user, format, file, and map and their values.

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.


JSON, doctools, export, index, serialization


Text formatter plugin


Copyright © 2009-2019 Andreas Kupries