doctoc_lang_cmdref(3tcl)

✨ doctoc_lang_cmdref — the doctoc language command reference ✨

okay bestie so this is doctoc_lang_cmdref, from the 3tcl manual, and it's basically the master list of every single command in the doctoc markup language. every one. no skips. let's go 💖

---

📖 SYNOPSIS

comment plaintext

division_end

division_start text ?symfile?

include filename

item file text desc

lb

rb

toc_begin text title

toc_end

vset varname value

vset varname

---

🌸 DESCRIPTION

so this document does two things at once (multitasking queen 👑): it tells you the names of every command in the doctoc markup language, and the syntax of each one. version 1, specifically. 💅

because this is a reference and not a tutorial, the commands are listed in alphabetical order and the descriptions are pretty short — like, snack-sized. if you're a beginner, pls pls pls go read the way more informally written doctoc language introduction first, fr fr. this page is not the vibe for learning from scratch. 🫶

---

🎀 COMMANDS

• comment plaintext — toc markup, bestie. the argument text gets marked up as a comment that stands outside the actual text of the document. main use case is in free-form text. 💬
• division_end — toc structure. this one closes the division that was opened by the last division_begin command coming before it and not yet closed. it's the closer. the periodt of divisions. 🚪
• division_start text ?symfile? — toc structure. this one opens a division in the table of contents. its counterpart is division_end — they're a duo, a package deal. together they let a user give a table of contents some extra structure. ✨

the title of the new division comes from the argument text.

and if the symbolic filename symfile is present, then the section title should link to the referenced document — if links are supported by the output format. (if not, well. 🙈)

• include filename — templating. the contents of the named file get interpreted as text written in doctoc markup, and processed right in the place of the include command. important: the markup in that file has to be self-contained. a markup command cannot cross the file boundaries. no hopping fences. 🚧
• item file text desc — toc structure. adds one individual element to the table of contents. each such element refers to a document, and that document is specified through the symbolic name file. the text argument labels the reference, while desc gives a short descriptive text of that document. 📝

the symbolic names are there to preserve the convertibility of this format to any output format. the actual name of the file gets inserted by the chosen formatting engine when it converts the input — based on a mapping from symbolic to actual names that you give to the engine. iykyk. 🔥

• lb — text. gets replaced with a left bracket. use it in free-form text. it's required to avoid a left bracket being interpreted as the start of a markup command. ⚠️ its usage is restricted to the arguments of other markup commands.
• rb — text. gets replaced with a right bracket. use it in free-form text. required to avoid a right bracket being interpreted as the end of a markup command. ⚠️ its usage is restricted to the arguments of other commands.
• toc_begin text title — document structure. the command that starts a table of contents. 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), without markup. 🏁

the label is often the name of the package (or extension) that the documents belong to.

• toc_end — document structure. the command that ends a table of contents. 🛑

anything in the document coming after this command is in error. so like. don't. 💀

• vset varname value — templating. in this form, the command sets the named document variable to the specified value. it does not generate output — i.e. the command is replaced by the empty string. silent but powerful. 🤫
• vset varname — templating. in this form, the command is replaced by the value of the named document variable. 🪄

---

😭 BUGS, IDEAS, FEEDBACK

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. it's giving humble but also realistic. pls report such things in the category doctools of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. and while you're there, also report any ideas for enhancements you may have for either the package and/or the documentation. we love a glow-up suggestion. 🌈

when proposing code changes, pls provide unified diffs, i.e. the output of diff -u. no cap.

also note further that attachments are strongly preferred over inlined patches. you can make an attachment 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. that's the one. 👈

---

👀 SEE ALSO

doctoc_intro, doctoc_lang_faq, doctoc_lang_intro, doctoc_lang_syntax

go read those too bestie, they're all part of the family 💜

---

🔑 KEYWORDS

doctoc commands, doctoc language, doctoc markup, markup, semantic markup

---

🗂️ CATEGORY

Documentation tools

---

©️ COPYRIGHT

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

---

and that's the whole page!! this came from tcllib, version 1.0, and it's the doctoc_lang_cmdref(3tcl) page. ty for reading, you absolutely ate this 💅✨🎀 🦋