doctools::msgcat - Documentation tools

[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# doctools::msgcat(n) 0.2 tcllib "Documentation tools"

## Name

doctools::msgcat - Message catalog management for the various document parsers

## Synopsis

- package require Tcl 8.5 9
- package require msgcat
- package require doctools::msgcat ?0.2?

- ::doctools::msgcat::init prefix

## Description

The package doctools::msgcat is a support module handling the selection of message catalogs for the various document processing packages in the doctools system version 2. As such it is an internal package a regular user (developer) should not be in direct contact with.

If you are such please go the documentation of either

1. doctools::doc,

2. doctools::toc, or

3. doctools::idx

Within the system architecture this package resides under the various parser packages, and is shared by them. Underneath it, but not explicit dependencies, are the packages providing the message catalogs for the various languages.

## API

::doctools::msgcat::init prefix

  The command locates and loads the message catalogs for all the languages returned by msgcat::mcpreferences, provided that they could be found. It returns an integer number describing how many packages were found and loaded.

  The names of the packages the command will look for have the form "doctools::msgcat::prefix::langcode", with prefix the argument to the command, and the langcode supplied by the result of msgcat::mcpreferences.

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category doctools of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

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.

## Keywords

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

## Category

Documentation tools

## Copyright

Copyright © 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>