doctools_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

🎀 doctools_lang_faq — the doctools language FAQ, bestie edition ✨

ok so real talk, this is the manual page for doctools_lang_faq from the doctools documentation tools. it's the FAQ page. it's... a work in progress. let's get into it 💖

🌸 DESCRIPTION

✨ OVERVIEW

💅 WHAT IS THIS DOCUMENT?

okay so bestie, full transparency: right now this document is mostly a placeholder. it's a spot meant to hold all the commonly asked questions about the doctools markup language and its companions — plus the answers — but the questions and answers haven't actually been filled in yet. it's giving "reserved parking spot" energy. 🙈

and like, if you have questions (or even better, answers) that you think should live here, please report them! the section Bugs, Ideas, Feedback down below tells you exactly how. we want your input fr fr 🫶

🌈 EXAMPLES

🔥 WHERE DO I FIND DOCTOOLS EXAMPLES?

so here's the thing — we have no direct examples of documents written using doctools markup. none. zero. ngl, it's a little awkward. 😭

BUT. plot twist. the doctools processor dtplite does generate a table of contents when it processes 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 does not get deleted when the generation finishes. so those intermediate files can totally serve as examples. main character loophole, honestly. 👑

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

  1. A snapshot of Tcllib. how to grab one of those — and the tools you'll need for it — is described over at Development Snapshots [/wiki?name=Development+Snapshots]
  2. A Tcllib release archive. those live on the home [/home] page.

slay, go forth and read some real markup ✨

💀 BUGS, IDEAS, FEEDBACK

not to be dramatic but this document, and the package it describes, will undoubtedly contain bugs and other problems. it's just how it is. 😭

so please report them! in the category doctools of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. and while you're there, also drop any ideas you have for enhancements — for either the package and/or the documentation. we want all of it 💖

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

also, heads up: attachments are strongly preferred over inlined patches. to attach something, go to the Edit form of the ticket immediately after you create it, then use the left-most button in the secondary navigation bar. iykyk 🎀

👀 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 (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>

and that's the whole page bestie!! 🫶 this was tcllib version 1.0, and if you ever need to find it again it lives under the name doctools_lang_faq(n). go be iconic with your markup, ily, bye!! 💅✨🌸

📦 where this page comes from