doctoc_lang_faq(n)

📦 version 2.0, in alpine 3.24, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

💖 doctoc_lang_faq(n) 💖

okay so bestie, welcome to doctoc_lang_faq — the FAQ for the doctoc markup language, filed under Documentation tools. she's cute, she's here to answer your questions, and rn she's mostly just vibing as a placeholder. let's get into it 🦋

✨ OVERVIEW ✨

🌸 WHAT IS THIS DOCUMENT? 🌸

ngl, this document is currently mainly a placeholder, fr fr. the plan is for it to be filled with commonly asked questions about the doctoc markup language and its companions, plus the answers to those questions. right now it's giving "coming soon" energy and we respect the anticipation 💅

please report any questions (and, if possible, answers) that you think we should consider for this document — how to do that is all explained down in the Bugs, Ideas, Feedback section below. don't be shy, we want your questions, periodt 🫶

🎀 EXAMPLES 🎀

🔥 WHERE DO I FIND DOCTOC EXAMPLES? 🔥

so here's the thing — we have no direct examples of documents written using doctoc markup. like, zero, none, it's giving empty folder 😭

BUT. 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 uses for that? that file uses doctoc markup, and it is not deleted when generation completes. so those files can totally serve as examples. accidental tutorial, iconic behavior honestly 👑

dtplite is distributed as part of Tcllib, so to get it you need one of these two things:

  1. A snapshot of Tcllib. how to retrieve such a snapshot and the tools required for this are described at Development Snapshots [/wiki?name=Development+Snapshots] ✨
  2. A Tcllib release archive. they are available at the home [/home] page 🌈

💀 BUGS, IDEAS, FEEDBACK 💀

bestie, let's be real: this document, and the package it describes, will undoubtedly contain bugs and other problems. it's not a flaw, it's a lifestyle 🙈

please report such in the category doctools of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. and please also report any ideas for enhancements you may have for either the package and/or the documentation — we want them all, no cap 💖

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

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 move 🫶

👀 SEE ALSO 👀

  • doctoc_lang_cmdref
  • doctoc_lang_intro
  • doctoc_lang_syntax

⭐ 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>

okay that's the whole page bestie, you ate it 💅 this lil doc came to you from tcllib, version 1.0, manual page doctoc_lang_faq(n). take care of her, she's a placeholder but she's our placeholder 🎀✨🦋

📦 where this page comes from