1[comment {-*- tcl -*- doctools manpage}]
2[manpage_begin doctools::msgcat n 0.1]
3[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
4[moddesc   {Documentation tools}]
5[titledesc {Message catalog management for the various document parsers}]
6[category  {Documentation tools}]
7[require Tcl 8.4]
8[require msgcat]
9[require doctools::msgcat [opt 0.1]]
10[description]
11[keywords doctools docidx doctoc {message catalog}]
12[keywords localization l10n internationalization i18n]
13[keywords {catalog package} {message package}]
14
15The package [package doctools::msgcat] is a support module handling
16the selection of message catalogs for the various document processing
17packages in the doctools system version 2. As such it is an internal
18package a regular user (developer) should not be in direct contact
19with.
20
21[para]
22
23If you are such please go the documentation of either
24
25[list_begin enumerated]
26[enum] [package doctools::doc],
27[enum] [package doctools::toc], or
28[enum] [package doctools::idx]
29[list_end]
30
31[para]
32
33Within the system architecture this package resides under the various
34parser packages, and is shared by them. Underneath it, but not
35explicit dependencies, are the packages providing the message catalogs
36for the various languages.
37
38[section API]
39
40[list_begin definitions]
41
42[call [cmd ::doctools::msgcat::init] [arg prefix]]
43
44The command locates and loads the message catalogs for all the
45languages returned by [cmd msgcat::mcpreferences], provided that they
46could be found. It returns an integer number describing how many
47packages were found and loaded.
48
49[para]
50
51The names of the packages the command will look for have the form
52"doctools::msgcat::[arg prefix]::[var langcode]", with [arg prefix]
53the argument to the command, and the [var langcode] supplied by the
54result of [cmd msgcat::mcpreferences].
55
56[list_end]
57
58
59[vset CATEGORY doctools]
60[include include/feedback.inc]
61[manpage_end]
62