doctools_lang_faq(3tcl)

💖 doctools_lang_faq — the doctools language FAQ 💖

okay bestie, welcome to doctools_lang_faq, a page from the Documentation tools corner of the tcllib manual universe 🦋. Think of it as the FAQ page for the doctools markup language — except, plot twist, it's mostly an empty scrapbook waiting for y'all to send in your questions. Let's get into it 💅

---

✨ NAME ✨

doctools_lang_faq — the doctools language faq, fr fr 🌸

---

🎀 DESCRIPTION 🎀

💜 OVERVIEW 💜

🌟 WHAT IS THIS DOCUMENT? 🌟

ngl, this document is currently mainly a placeholder 🙈. It's meant to be filled with the commonly asked questions about the doctools markup language and its companions, plus their answers. Right now it's giving "reserved seat at the group chat" energy — the seat exists, the messages haven't arrived yet 💀

So please, bestie, report any questions (and, if you possibly can, the answers too) that you think we should consider for this document. The whole how-to is explained down in the section Bugs, Ideas, Feedback below 👇

---

🦋 EXAMPLES 🦋

🌈 WHERE DO I FIND DOCTOOLS EXAMPLES? 🌈

Okay so real talk: we have no direct examples of documents written using doctools markup 😭. None. Zero. The vibe is "trust me bro, it works."

BUT — and this is the slay 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 table of contents? It uses doctools markup itself, and it is not deleted when generation completes 🎉. So those leftover files can absolutely serve as your examples. Iconic behavior honestly 👑

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

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 🫶

This document, and the package it describes, will undoubtedly contain bugs and other problems 😭. That's just how it is, no cap. 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 — we want them all, every single one 💖

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 👈

---

👀 SEE ALSO 👀

• doctools_lang_cmdref
• doctools_lang_intro
• doctools_lang_syntax

---

🔥 KEYWORDS 🔥

doctools commands, doctools language, doctools markup, doctools syntax, examples, faq, 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 was brought to you by tcllib version 1.0 — mwah, go forth and document 💖✨🦋🌸💅