doctools::msgcat::toc::c(n)

πŸ“¦
version 2.0 Β· 2 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

πŸ’– doctools::msgcat::toc::c β€” the vibe ✨

okay so bestie, welcome to the manual page for doctools::msgcat::toc::c, part of the Documentation tools crew in Tcllib. it's short, it's sweet, it's giving "internal business only" πŸŽ€


🌸 NAME 🌸

doctools::msgcat::toc::c β€” the Message catalog for the doctoc parser (C). that's it, that's the whole name, and yes the "C" means the C language. periodt πŸ’…


✨ SYNOPSIS ✨

package require Tcl 8.5 9

package require msgcat

package require doctools::msgcat::toc::c ?0.1?

so you need Tcl 8.5 through 9, you need msgcat, and you need the package itself β€” optionally pinned to version 0.1. the ? means it's optional, not that the docs are unsure, bestie. 🫢


πŸ’œ DESCRIPTION πŸ’œ

okay so here's the tea β˜• β€” doctools::msgcat::toc::c is a support module. its whole job is providing the C language message catalog for the doctoc parser in the doctools system, version 2. that's it. that's the gig.

and because of that, it's an internal package. a regular user (developer) should not be in direct contact with it. like, it's not for you, it's backstage, it's the crew in black hoodies moving the set pieces around while you're in the audience. no cap.

if you are the kind of person who's supposed to be poking at this, then please, respectfully, go read the documentation of one of these instead:

  1. doctools::doc
  2. doctools::toc
  3. doctools::idx

now, where does this little guy live in the system architecture? it resides under the package doctools::msgcat, which is the thing that handles general message catalog management across the whole system. ✨

and here's a fun architectural fact: there is no explicit dependency between the manager and the catalog packages. the catalog is a plugin β€” it gets selected and loaded dynamically. slay. πŸ”₯


πŸ¦‹ API πŸ¦‹

shortest section ever, and honestly iconic for it:

this package has no exported API. nothing. zero. nada. the void. πŸ’€


😭 BUGS, IDEAS, FEEDBACK 😭

ngl bestie, this document, and the package it describes, will undoubtedly contain bugs and other problems. it's not a maybe, it's a when. πŸ™ˆ

please report such in the category doctools of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. and if you've got ideas for enhancements β€” for the package, for the docs, either, both β€” please report those too. we want them. 🫢

when proposing code changes, please provide unified diffs, i.e. the output of diff -u. not vibes, not screenshots of your editor, the actual diff.

also note further: attachments are strongly preferred over inlined patches. to attach something, go to the Edit form of the ticket immediately after its creation, and then use the left-most button in the secondary navigation bar. that's the secret door. iykyk. πŸŽ€


πŸ‘‘ KEYWORDS πŸ‘‘

C, catalog package, doctoc, doctools, i18n, internationalization, l10n, localization, message catalog, message package


🌈 CATEGORY 🌈

Documentation tools


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


and that's the whole page, bestie! 🧚 this was tcllib, version 0.1, for doctools::msgcat::toc::c(n) β€” go forth, stay internal, and don't touch the plugin unless you know what you're doing. mwah πŸ’…πŸŒΈ

πŸ“¦ where this page comes from