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

✨ doctools::toc::export::wiki — the wiki export plugin, bestie edition ✨

okay so this page is about doctools::toc::export::wiki, a documentation-tools situation, and I am so ready to explain it. it's a wiki export plugin. let's get into it 💅

---

🌸 NAME 🌸

doctools::toc::export::wiki — it's a wiki export plugin. that's the whole name. iconic.

---

🎀 SYNOPSIS 🎀

package require Tcl 8.5 9

package require doctools::toc::export::wiki ?0.2?

package require doctools::text

export serial configuration

there it is. Tcl 8.5 9, the package itself with that optional ?0.2? version, doctools::text, and the one command: export serial configuration. 🫶

---

💖 DESCRIPTION 💖

so this package implements the doctools table of contents export plugin for generating wiki markup. that's the job. that's the whole job.

ngl, this is an internal package of doctools — it exists to be used by the higher-level management packages that handle tables of contents, and specifically by doctools::toc::export, the export manager. so like, it's not really for you to call directly.

can you use it from a regular interpreter? technically yeah. should you? it's possible, however only with contortions, and it is NOT recommended. 😭 the proper way — the main character way — is through the package doctools::toc::export and the export manager objects it hands you. periodt.

---

🦋 API 🦋

the API here satisfies the spec of the doctoc export plugin API version 2. so it's official. it's certified. it's giving standards-compliant.

export serial configuration

This command takes the canonical serialization of a table of contents, as specified in section ToC serialization format, and contained in serial, the configuration, a dictionary, and generates wiki markup encoding the table. The created string is then returned as the result of the command.

so: serial goes in, configuration goes in, wiki markup comes out. that's the vibe check and it passed. ✨

---

🌈 WIKI MARKUP 🌈

the basic syntax of the wiki markup this plugin generates is described over at http://wiki.tcl.tk/14. go look, i'll wait 🍓

but bestie, plot twist — the plugin goes beyond the classic markup to generate proper headers and indenting. so it's the classic markup but upgraded. glow-up behavior fr fr.

---

👑 CONFIGURATION 👑

the wiki export plugin recognizes the following configuration variables and changes its behaviour as they specify. here we go:

• dictionary map — this standard configuration variable contains a dictionary mapping from the (symbolic) document ids in reference entries to the actual filenames and/or urls to be used in the output.

and like, important detail: document ids that don't have a mapping? they're used unchanged. no mapping, no problem.

🚨 heads up bestie: this plugin ignores the standard configuration variables user, file and format, and their values. completely. not even looking at them. 💀

---

🧚 TOC SERIALIZATION FORMAT 🧚

okay this is the big one, the lore drop. here's the format the doctools v2 packages use to serialize tables of contents as immutable values for transport, comparison, etc. we're doing this properly.

we gotta distinguish between regular and canonical serializations. a table of contents can have more than one regular serialization, but only exactly one of them is canonical. one of one. the chosen one. ⭐

regular serialization

1. The serialization of any table of contents is a nested Tcl dictionary.
2. This dictionary holds a single key, doctools::toc, and its value. This value holds the contents of the table of contents.
3. The contents of the table of contents are a Tcl dictionary holding the title of the table of contents, a label, and its elements. The relevant keys and their values are
   • title — The value is a string containing the title of the table of contents.
   • label — The value is a string containing a label for the table of contents.
   • items — The value is a Tcl list holding the elements of the table, in the order they are to be shown.

Each element is a Tcl list holding the type of the item, and its description, in this order. An alternative description would be that it is a Tcl dictionary holding a single key, the item type, mapped to the item description.

The two legal item types and their descriptions are

• reference — This item describes a single entry in the table of contents, referencing a single document. To this end its value is a Tcl dictionary containing an id for the referenced document, a label, and a longer textual description which can be associated with the entry. The relevant keys and their values are
  • id — The value is a string containing the id of the document associated with the entry.
  • label — The value is a string containing a label for this entry. This string also identifies the entry, and no two entries (references and divisions) in the containing list are allowed to have the same label.
  • desc — The value is a string containing a longer description for this entry.
• division — This item describes a group of entries in the table of contents, inducing a hierarchy of entries. To this end its value is a Tcl dictionary containing a label for the group, an optional id to a document for the whole group, and the list of items in the group. The relevant keys and their values are
  • id — The value is a string containing the id of the document associated with the whole group. This key is optional.
  • label — The value is a string containing a label for the group. This string also identifies the entry, and no two entries (references and divisions) in the containing list are allowed to have the same label.
  • items — The value is a Tcl list holding the elements of the group, in the order they are to be shown. This list has the same structure as the value for the keyword items used to describe the whole table of contents, see above. This closes the recursive definition of the structure, with divisions holding the same type of elements as the whole table of contents, including other divisions.

🌀 yes bestie it's recursive. divisions inside divisions inside divisions. it's turtles all the way down and it's honestly kinda iconic.

canonical serialization

The canonical serialization of a table of contents 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 this table of contents.

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.

so like, same structure as above, but every nested dictionary gets its keys sorted ascending dictionary-style. that's the only glow-up. that's the canonical ✨

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. 😭 that's just how it is, bestie. so please report them — in the category doctools of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. and if you've got ideas for enhancements for the package and/or the documentation? report those too. we love ideas here. 🫶

when you're proposing code changes, please provide unified diffs, i.e. the output of diff -u. that's the move.

and one more thing — attachments are strongly preferred over inlined patches. to attach something, go to the Edit form of the ticket immediately after its creation, and then use the left-most button in the secondary navigation bar. yes it's a scavenger hunt but you got this. 🎀

---

⭐ KEYWORDS ⭐

doctools, export, serialization, table of contents, toc, wiki

---

🎀 CATEGORY 🎀

Text formatter plugin

---

💜 COPYRIGHT 💜

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

---

and that's the whole page, bestie!! 🦋 this was tcllib, version 0.2, and it's part of the doctools::t...export::wiki(n) manual. go export some tables of contents, you absolute legend 💅👑✨