docidx_lang_cmdref(3tcl)

✨ NAME ✨

okay so bestie, welcome to docidx_lang_cmdref — the docidx language command reference, like the whole entire dictionary of every command in the docidx markup language 💅 (and yes the manual page lives in section 3tcl under Documentation tools, iykyk)

---

📜 SYNOPSIS 📜

comment plaintext

include filename

index_begin text title

index_end

key text

lb

manpage file text

rb

url url label

vset varname value

vset varname

---

💖 DESCRIPTION 💖

This document spells out both the names and the syntax of every single command that together make up the docidx markup language, version 1 🎀

And because this is meant to be a reference, the commands are listed in alphabetical order and the descriptions are kept pretty short, ngl. So if you're a total beginner, do yourself a favor and read the way more informally written docidx language introduction first, fr fr 🫶

---

👑 COMMANDS 👑

• comment plaintext — Index markup. The argument text gets marked up as a comment that sits outside of the actual text of the document. Main use? Free-form text, basically just vibing in the margins 🍓
• include filename — Templating. The contents of the named file get interpreted as text written in docidx markup and processed right in the place of the include command. Heads up though: the markup in that file has to be self-contained. A markup command cannot cross the file boundaries, periodt 💀
• index_begin text title — Document structure. This is the command that starts an index. The arguments are a label for the whole group of documents the index refers to (text) and the overall title text for the index (title), with no markup in it.

That label is often just the name of the package (or extension) the documents belong to 👑

• index_end — Document structure. The command that ends an index. Anything in the document that comes after this command is in error — so like, don't 🙈
• key text — Index structure. This command adds the keyword text to the index ✨
• lb — Text. This command gets replaced with a left bracket. Use it in free-form text. It's required so that a left bracket doesn't get interpreted as the start of a markup command. Its usage is restricted to the arguments of other markup commands — no wandering off 🦋
• manpage file text — Index structure. This command adds an element to the index that refers to a document. The document is specified through the symbolic name file. The text argument is what labels the reference.

Symbolic names are used so the convertibility of this format to any output format is preserved 💖 The actual name of the file gets inserted by whichever formatting engine you picked when it converts the input — and that's based on a mapping from symbolic names to actual names that you hand to the engine. Slay.

• rb — Text. This command gets replaced with a right bracket. Use it in free-form text. It's required so that a right bracket doesn't get interpreted as the end of a markup command. Its usage is restricted to the arguments of other commands 🎀
• url url label — Index structure. This is the second command that adds an element to the index. But plot twist: to refer to a document it does not use a symbolic name — it uses a (possibly format-specific) url describing the exact location of the document being indexed here 🌈
• vset varname value — Templating. In this form, the command sets the named document variable to the specified value. It generates no output — i.e. the command is replaced by the empty string. Silent but iconic 💅
• vset varname — Templating. In this form, the command is replaced by the value of the named document variable 👑

---

😭 BUGS, IDEAS, FEEDBACK 😭

Not me having to say this, but: this document, and the package it describes, will undoubtedly contain bugs and other problems. Please report them in the category doctools of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. And please also drop any ideas you have for enhancements to either the package and/or the documentation — we want them 🫶

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

Also note: attachments are strongly preferred over inlined patches. You can make an attachment by going to the Edit form of the ticket immediately after creating it, and then using the left-most button in the secondary navigation bar. Do that, bestie, don't just paste a wall of text 💀

---

🌸 SEE ALSO 🌸

• docidx_intro
• docidx_lang_faq
• docidx_lang_intro
• docidx_lang_syntax

---

⭐ KEYWORDS ⭐

docidx commands, docidx language, docidx markup, markup, semantic markup

---

🎀 CATEGORY 🎀

Documentation tools

---

💜 COPYRIGHT 💜

Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

and that's the whole page, bestie!! this masterpiece is tcllib version 1.0 and it's dated way back — the page itself says docidx_lang_cmdref(3tcl), so you know exactly where you are 💖 go forth and mark up some indexes, you absolute icon 👑✨