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

📦
version 2.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

💖 doctools::idx::export::html 💖

okay bestie, welcome to doctools::idx::export::html, straight out of the Documentation tools manual. it's the HTML export plugin, and yeah, we're gonna read the whole thing together. grab a snack. 🍓

✨ NAME ✨

doctools::idx::export::html — HTML export plugin. that's it, that's the whole name, short and iconic. 💅

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

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

package require doctools::text

package require doctools::html

package require doctools::html::cssdefaults

export serial configuration

look at that stack of package requires. it's giving dependency queen. 👑

💅 DESCRIPTION 💅

so this package implements the doctools keyword index export plugin for generating HTML markup. it takes your keyword index and turns it into HTML, no cap. ✨

lowkey important context: this is an internal package of doctools, meant to be used by the higher level management packages that handle keyword indices — especially doctools::idx::export, the export manager. iykyk.

can you use it from a regular interpreter? technically yes. should you? no. the manual says it's only possible "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. that's the main character route. 🫶

🎀 API 🎀

the API this package provides satisfies the spec of the docidx export plugin API version 2. periodt.

  • export serial configuration — this command takes the canonical serialization of a keyword index (as specified in the section Keyword index serialization format) contained in serial, plus the configuration, a dictionary, and generates HTML markup encoding the index. the created string is then returned as the result of the command. slay. 💖

🦋 CONFIGURATION 🦋

the html export plugin recognizes the following configuration variables and changes its behaviour as they specify. buckle up, there's a bunch. 🌈

  • string user — this standard configuration variable holds the name of the user running the process which invoked the export plugin. the plugin puts this info into the provenance comment at the beginning of the generated document. 💌
  • string file — this standard configuration variable holds the name of the file the index came from. note: this variable may not be set or may contain the empty string. the plugin puts this info, if defined (i.e. set and not the empty string), into the provenance comment at the beginning of the generated document.
  • 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 are used unchanged. no mapping, no meddling. ✨
  • boolean newlines — if this flag is set, the plugin will break the generated html code across lines, with each markup command on a separate line. if this flag is not set (the default), the whole document gets written on a single line, with minimum spacing between all elements. one long line, bestie. 📜
  • boolean indented — if this flag is set, the plugin will indent the markup commands according to the structure of indices. to make this work, this also implies that newlines is set. if this flag is not set (the default), the output is formatted as per the value of newlines, and no indenting is done.
  • string meta — this variable is meant to hold a fragment of HTML (default: empty). the fragment it contains will be inserted into the generated output in the <head> section of the document, just after the <title> tag. 🎀
  • string header — this variable is meant to hold a fragment of HTML (default: empty). the fragment it contains will be inserted into the generated output just after the <h1> title tag in the body of the document, in the class.header <div>'ision.
  • string footer — this variable is meant to hold a fragment of HTML (default: empty). the fragment it contains will be inserted into the generated output just before the </body> tag, in the class.footer <div>'ision.
  • dictionary kwid — the value of this variable (default: empty) maps keywords to the identifiers to use as their anchor names. each keyword FOO not found in the dictionary uses KW-FOO as anchor, i.e. itself prefixed with the string KW-. so it just names itself. iconic. 💅
  • string sepline — the value of this variable is the string to use for the separator comments inserted into the output when the outpout is broken across lines and/or indented. the default string consists of 60 dashes.
  • integer kwidth — this variable holds the size of the keyword column in the main table generated by the plugin, in percent of the total width of the table. it's an integer number in the range of 1 to 99. choosing a value outside of that range causes the generator to switch back to the defauly setting, 35 percent. 👀
  • string dot — this variable contains a HTML fragment inserted between the entries of the navigation bar, and the references associated with each keyword. the default is the HTML entity &#183; i.e. the bullet character, also known as the "Greek middle dot", i.e. the unicode character 00B7. cute little dot, doing a lot. 🌟
  • string class.main — this variable contains the class name for the main <div>'ivision of the generated document. the default is doctools.
  • string class.header — this variable contains the class name for the header <div>'ision of the generated document. the default is idx-header. this division contains the document title, the user specified header (if any), a visible separator line, and the navigation bar for quick access to each keyword section.
  • string class.title — this variable contains the class name for the <h1> tag enclosing the document title. the default is idx-title.
  • string class.navsep — this variable contains the class name for the <hr> separators in the header and footer sections of the generated document. the default is idx-navsep.
  • string class.navbar — this variable contains the class name for the navigation <div>'ision enclosing the navigation bar of the generated document. the default is idx-kwnav.
  • string class.contents — this variable contains the class name for the <table> holding the keywords and their references in the generated document. the default is idx-contents.
  • string class.leader — this variable contains the class name for the anchor names the plugin inserts into the keyword table when switching from one section to the next (each section holds all keywords with a particular first character). the default is idx-leader.
  • string class.row0 — this variable contains the class name used to label the even rows (<tr>) of the keyword table. the default is idx-even.
  • string class.row1 — this variable contains the class name used to label the odd rows (<tr>) of the keyword table. the default is idx-odd.
  • string class.keyword — this variable contains the class name used to label the keyword cells/column (<td>) in the keyword table of the document. the default is idx-keyword.
  • string class.refs — this variable contains the class name used to label the reference cells/column (<td>) in the keyword table of the document. the default is idx-refs.
  • string class.footer — this variable contains the class name for the footer <div>'ision of the generated document. the default is idx-footer. this division contains a browser-visible separator line and the user specified footer, if any.
⚠️ heads up bestie: this plugin ignores the standard configuration variable format, and its value. don't even try it. 💀

and that's the whole config section! part 1 done, but we're not done done — there's more coming, so don't go anywhere. 💖

💖 KEYWORD INDEX SERIALIZATION FORMAT 💖

okay bestie, here’s where 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. periodt. 👑

✨ 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 previous item for its definition. 🔁

  1. 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. it’s giving main character energy, only one can sit on the throne 💅

  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. 🙈

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 👑

HTML, doctools, export, index, serialization

🧚 CATEGORY 🧚

Text formatter plugin

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

kisses from the tcllib crew 💖 this page is from tcllib, version 0.3, and the date? The footer keeps it mysterious, but bestie, it’s iconic anyway. 🦋✨

📦 where this page comes from