doctools:...port::wiki(3tcl)

✨ NAME ✨

doctools::idx::export::wiki — the wiki export plugin 💅 (yes that's the manual name up top, doctools:...port::wiki(3tcl), we're living in the 3tcl section bestie, buckle up)

---

🦋 SYNOPSIS 🦋

package require Tcl 8.5 9

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

package require doctools::text

export serial configuration

---

🌸 DESCRIPTION 🌸

Okay so this package is the doctools keyword index export plugin, and its whole job is generating wiki markup. Iconic behaviour, no notes. ✨

It's an internal package of doctools, fr fr — it exists for the higher level management packages that handle keyword indices, especially doctools::idx::export, which is the export manager. It's giving "backstage crew, not main character" energy.

Not me being real with you: using it straight from a regular interpreter is possible, but only with contortions, and it is not recommended. The proper way to use this functionality is through the package doctools::idx::export and the export manager objects it provides. Periodt. 🫶

---

💜 API 💜

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

• export serial configuration — this command takes the canonical serialization of a keyword index (as specified in the section Keyword index serialization format, iykyk), contained in serial, plus the configuration, which is a dictionary, and it generates wiki markup encoding the index. The created string is then returned as the result of the command. The way that it just… returns a string. Chef's kiss. 💖

---

🌈 WIKI MARKUP 🌈

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

And lowkey, the plugin goes beyond the classic markup — it generates proper headers, plus either a table or an indented list of the keywords and their references. Highkey extra, we love that for it. 👑

---

🎀 CONFIGURATION 🎀

The wiki export plugin recognizes the following configuration variables and changes its behaviour as they specify. Vibe check passed:

• map (dictionary) — this standard configuration variable contains 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 are used unchanged. No edits, no glow-up, just vibes. 💅
• style (enum) — 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.

Heads up bestie: this plugin ignores the standard configuration variables user, file and format, and their values. It simply does not see them. Not its business. 🙈

---

⭐ 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. Immutable. Frozen. Untouchable. 💀

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. There can only be one 👑

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 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. Extra. Special. One of a kind. ✨

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. 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. We want the feedback, bestie, we thrive on it 🫶

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. Go find that button. It's right there. You got this. 💪

---

🔥 KEYWORDS 🔥

doctools, export, index, serialization, wiki

---

💖 CATEGORY 💖

Text formatter plugin

---

👑 COPYRIGHT 👑

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

---

and that's the whole page bestie, mwah 💋 This one's brought to you by tcllib, version 0.3, of doctools:...port::wiki(3tcl) — stay hydrated, keep your serializations canonical, and go read the actual docs if you're gonna use this in production. no cap. 🎀🦋💜