[//000000001]: # (doctools::idx::export::wiki \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries ) [//000000004]: # (doctools::idx::export::wiki\(n\) 0\.2 tcllib "Documentation tools")
[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]
# NAME doctools::idx::export::wiki \- wiki export plugin # Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [API](#section2) - [Wiki markup](#section3) - [Configuration](#section4) - [Keyword index serialization format](#section5) - [Bugs, Ideas, Feedback](#section6) - [Keywords](#keywords) - [Category](#category) - [Copyright](#copyright) # SYNOPSIS package require Tcl 8\.4 package require doctools::idx::export::wiki ?0\.2? package require doctools::text [__[export](\.\./\.\./\.\./\.\./index\.md\#export)__ *serial* *configuration*](#1) # DESCRIPTION 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](idx\_export\.md)__, 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](idx\_export\.md)__ 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\. - __[export](\.\./\.\./\.\./\.\./index\.md\#export)__ *serial* *configuration* This command takes the canonical serialization of a keyword index, as specified in section [Keyword index serialization format](#section5), and contained in *serial*, the *configuration*, a dictionary, and generates wiki markup encoding the index\. The created string is then returned as the result of the command\. # Wiki markup The basic syntax of the wiki markup generated by this plugin are described at [http://wiki\.tcl\.tk/14](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\. # Configuration The wiki export plugin recognizes the following configuration variables and changes its behaviour as they specify\. - dictionary *map* This standard configuration variable contains a dictionary mapping from the symbolic files names in manpage references to the actual filenames and/or urls to be used in the output\. Url references and symbolic file names without a mapping are used unchanged\. - enum *style* This variable recognizes two values as legal, __list__ \(default\), and __table__\. Depending on the value the plugin generates either a list\- or table\-based wiki page for the index\. *Note* that this plugin ignores the standard configuration variables __user__, __file__ and __format__, 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*\. - regular serialization 1. An index serialization is a nested Tcl dictionary\. 1. This dictionary holds a single key, __doctools::idx__, and its value\. This value holds the contents of the index\. 1. The contents of the index are a Tcl dictionary holding the title of the index, a label, and the keywords and references\. The relevant keys and their values are * __title__ The value is a string containing the title of the index\. * __label__ The value is a string containing a label for the index\. * __keywords__ The value is a Tcl dictionary, using the keywords known to the index as keys\. The associated values are lists containing the identifiers of the references associated with that particular keyword\. Any reference identifier used in these lists has to exist as a key in the __references__ dictionary, see the next item for its definition\. * __references__ The value is a Tcl dictionary, using the identifiers for the references known to the index as keys\. The associated values are 2\-element lists containing the type and label of the reference, in this order\. 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\. 1. The *[type](\.\./\.\./\.\./\.\./index\.md\#type)* of a reference can be one of two values, * __manpage__ The identifier of the reference is interpreted as symbolic file name, referring to one of the documents the index was made for\. * __url__ The identifier of the reference is interpreted as an url, referring to some external location, like a website, etc\. - canonical serialization The canonical serialization of a keyword index has the format as specified in the previous item, and then additionally satisfies the constraints below, which make it unique among all the possible serializations of the keyword index\. 1. The keys found in all the nested Tcl dictionaries are sorted in ascending dictionary order, as generated by Tcl's builtin command __lsort \-increasing \-dict__\. 1. The references listed for each keyword of the index, if any, are listed in ascending dictionary order of their *labels*, as generated by Tcl's builtin command __lsort \-increasing \-dict__\. # 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](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\. # KEYWORDS [doctools](\.\./\.\./\.\./\.\./index\.md\#doctools), [export](\.\./\.\./\.\./\.\./index\.md\#export), [index](\.\./\.\./\.\./\.\./index\.md\#index), [serialization](\.\./\.\./\.\./\.\./index\.md\#serialization), [wiki](\.\./\.\./\.\./\.\./index\.md\#wiki) # CATEGORY Text formatter plugin # COPYRIGHT Copyright © 2009\-2019 Andreas Kupries