doctools::i...export::wiki(n)

💖 NAME 💖

doctools::idx::export::wiki — the wiki export plugin, bestie. It lives in the Tcl manpage corner of the world (that's the (n) vibe, iykyk) and it is literally the plugin that turns a keyword index into wiki markup. Obsessed. 🦋

---

✨ SYNOPSIS ✨

package require Tcl 8.5 9

package require doctools::idx::export::wiki ?0.3?

package require doctools::text

export serial configuration

---

🌸 DESCRIPTION 🌸

So this package implements the doctools keyword index export plugin, and its whole job is generating wiki markup. Slay. 🎀

Now, real talk: this is an internal package of doctools. It's meant to be used by the higher-level management packages that handle keyword indices — especially doctools::idx::export, the export manager. That's the main character here, not this plugin.

You can use it from a regular interpreter, sure, but only with contortions, and it is not recommended. 💀 The proper way to get at this functionality is through the package doctools::idx::export and the export manager objects it hands you. Periodt.

---

👑 API 👑

The API this package provides satisfies the spec of the docidx export plugin API version 2. No cap.

• export serial configuration — this command takes the canonical serialization of a keyword index (the format is laid out in the Keyword index serialization format section below) sitting in serial, plus the configuration (a dictionary), and generates wiki markup that encodes the index. The string it creates is then returned as the result of the command. Cute, right? 🫶

---

🌈 WIKI MARKUP 🌈

The basic syntax of the wiki markup this plugin generates is described over at http://wiki.tcl.tk/14.

But the plugin doesn't just do the classic markup — it goes beyond, generating proper headers and either a table or an indented list of the keywords and their references. She ate. 🔥

---

💅 CONFIGURATION 💅

The wiki export plugin recognizes these configuration variables and switches up its behaviour as they specify:

• dictionary map — this standard configuration variable holds a dictionary mapping from the symbolic file 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 get used unchanged. Simple as. ✨
• enum style — this variable recognizes two values as legal: list (the default) and table. Depending on the value, the plugin generates either a list-based or a table-based wiki page for the index. Choose your fighter. 💖

Heads up bestie: this plugin ignores the standard configuration variables user, file and format, and their values. Not me being like "where did those go" — they're just not it for this plugin. 🙈

---

🧚 KEYWORD INDEX SERIALIZATION FORMAT 🧚

Here's where we spill the format the doctools v2 packages use to serialize keyword indices as immutable values — for transport, comparison, etc.

We distinguish between regular and canonical serializations. A keyword index may have more than one regular serialization, but exactly one of them will be canonical. Only one. Main character energy. ⭐

regular serialization

1. An index serialization is a nested Tcl dictionary.
2. This dictionary holds a single key, doctools::idx, and its value. This value holds the contents of the index.
3. 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 the previous item for its definition.
4. The type of a reference can be one of two values:
   • manpage — the identifier of the reference is interpreted as a 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.
2. 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. It's giving "we know, we know". Please report such in the category doctools of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. Please also report any ideas for enhancements you may have for either the package and/or the documentation. We want the glow-up. 🫶

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. Yes, that one. That's the one. 👑

---

🔥 KEYWORDS 🔥

doctools, export, index, serialization, wiki

---

💜 CATEGORY 💜

Text formatter plugin

---

🎀 COPYRIGHT 🎀

Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

okay bestie that's the whole page, tysm for reading, mwah 💋 — this one came from tcllib, version 0.3, and it's the doctools::i...export::wiki manual page. go forth and export some wiki markup, you've got this 🦋✨