doctoc_lang_faq(3tcl)

📦 version 2.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

doctoc_lang_faq 💅

okay so bestie, welcome to the doctoc_lang_faq page — it lives in the Documentation tools corner of the 3tcl manuals, and it's literally the FAQ for the doctoc markup language. pull up a chair 🫶

✨ NAME ✨

doctoc_lang_faq — doctoc language faq 💖

🌸 DESCRIPTION 🌸

OVERVIEW

💜 WHAT IS THIS DOCUMENT?

ngl bestie, right now this document is mainly a placeholder. it's meant to be filled up with all the commonly asked questions about the doctoc markup language and its companions — plus the answers, obviously. like, the whole glow-up is still pending, no cap. 🎀

and listen, if you've got questions we should be considering for this doc (and, if you possibly can, the answers too 👀), please report them — the how-to is all explained down in the Bugs, Ideas, Feedback section below. don't be shy, we want them fr fr. 💌

🦋 EXAMPLES 🦋

WHERE DO I FIND DOCTOC EXAMPLES?

so here's the tea: we have no direct examples of documents written using doctoc markup. none. zero. nada. 😭

BUT — and this is the iconic part — the doctools processor dtplite does generate a table of contents when it's processing a set of documents written in doctools markup. and the intermediate file it makes for that? it uses doctoc markup, and it does not get deleted when generation completes. so those files can absolutely serve as your examples. slay. ✨

dtplite ships as part of Tcllib, so to get your hands on it you need one of these two things:

  1. A snapshot of Tcllib. how to retrieve such a snapshot and the tools you need for that are described over at Development Snapshots [/wiki?name=Development+Snapshots] 🌈
  2. A Tcllib release archive. those are available at the home [/home] page. 🏠

pick your fighter, both work 💅

👑 BUGS, IDEAS, FEEDBACK 👑

okay, real talk — 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 while you're there — please also report any ideas for enhancements you may have for either the package and/or the documentation. we want all of it. 🫶

when proposing code changes, please provide unified diffs, i.e. the output of diff -u. that's the vibe we need, no cap.

also note further: attachments are strongly preferred over inlined patches. 💖 to make an attachment, go to the Edit form of the ticket immediately after its creation, and then use the left-most button in the secondary navigation bar. easy. iconic. done. ✨

🌈 SEE ALSO 🌈

  • doctoc_lang_cmdref
  • doctoc_lang_intro
  • doctoc_lang_syntax

go read them, they're the whole friend group 💜

⭐ KEYWORDS ⭐

doctoc commands, doctoc language, doctoc markup, doctoc syntax, examples, faq, markup, semantic markup

🎀 CATEGORY 🎀

Documentation tools

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

and that's the whole page, bestie!! 🌸 this absolute legend of a manual page is brought to you by tcllib 1.0, doctoc_lang_faq(3tcl) — mwah, go forth and markup semantically 💅✨🦋

📦 where this page comes from