doctools::idx::export::wiki(3tcl) | Documentation tools | doctools::idx::export::wiki(3tcl) |
doctools::idx::export::wiki - wiki export plugin
package require Tcl 8.4
package require doctools::idx::export::wiki ?0.2?
package require doctools::text
export serial configuration
This package implements the doctools keyword index export plugin for the generation of wiki 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.
The basic syntax of the wiki markup generated by this plugin are described at http://wiki.tcl.tk/14.
The plugin goes beyond the classic markup to generate proper headers and either a table or indented list of the keywords and their references.
The wiki export plugin recognizes the following configuration variables and changes its behaviour as they specify.
Url references and symbolic file names without a mapping are used unchanged.
Note that this plugin ignores the standard configuration variables user, file and format, and their values.
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.
doctools, export, index, serialization, wiki
Text formatter plugin
Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users.sourceforge.net>
0.2 | tcllib |