doctools::msgcat::idx::c(n)

💖 doctools::msgcat::idx::c(n) 💖

Documentation tools — that's the manual she lives in, bestie, and this whole page is about the C-language message catalog for the docidx parser. Let's get into it 🫶

---

✨ NAME ✨

doctools::msgcat::idx::c — Message catalog for the docidx parser (C) 💅

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require msgcat

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

---

🦋 DESCRIPTION 🦋

okay so, the package doctools::msgcat::idx::c is a support module, right? And what it does is provide the C language message catalog for the docidx parser in the doctools system version 2. That's the whole gig. ✨

Which means it's an internal package — like, a regular user (a developer, even!) is genuinely not supposed to be in direct contact with it. It's giving backstage pass only, no cap. 🙈

So if you are one of those people who somehow ended up here anyway, bestie, please go read the documentation of either:

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

Those are the ones you actually want, fr fr. 👑

---

And where does this package live inside the system architecture? It resides under the package doctools::msgcat, which is the one providing the general message catalog management within the system. 🎀

Now here's a cute little detail: there is no explicit dependency between the manager and the catalog packages. Nope! The catalog is a plugin — it gets selected and loaded dynamically. It's giving main character energy that shows up when called, lowkey iconic. 💅

---

💜 API 💜

This package has no exported API.

That's it. That's the whole section. Nothing to see here, move along. 💀

---

🔥 BUGS, IDEAS, FEEDBACK 🔥

Okay so real talk: this document, and the package it describes, will undoubtedly contain bugs and other problems. Not a vibe, but it is what it is. 😭

Please report such in the category doctools of the Tcllib Trackers at [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 the glow-up ideas too, bestie. 🌈

---

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

ngl this one matters — a messy patch is not the serve we're going for. 🙈

---

Note further that attachments are strongly preferred over inlined patches. Periodt.

And how do you attach? 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 handshake. 🫶

---

⭐ KEYWORDS ⭐

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

---

🍓 CATEGORY 🍓

Documentation tools

---

👑 COPYRIGHT 👑

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

---

and that's the whole page, bestie!! this one shipped as version 0.1 from tcllib, and yeah — doctools::msgcat::idx::c(n) really is the whole vibe here. go forth and never call an internal package directly, mwah 💖✨🎀