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::export::docidx - docidx export plugin

Table Of Contents

SYNOPSIS

package require Tcl 8.4
package require doctools::idx::export::docidx ?0.2.1?

export serial configuration

DESCRIPTION

This package implements the doctools keyword index export plugin for the generation of docidx 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.

API

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

[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

and then proceed from there to the formal specifications, i.e. the documents

  1. docidx language syntax and

  2. docidx language command reference.

to get a thorough understanding of the language.

Configuration

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

Note that this plugin ignores the standard configuration variables format, 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.

KEYWORDS

docidx, doctools, export, index, serialization

CATEGORY

Text formatter plugin

COPYRIGHT

Copyright © 2009-2019 Andreas Kupries