Author: Harald Oehlmann <email@example.com> State: Final Type: Project Vote: Done Created: 17-Jul-2011 Post-History: Discussions-To: Tcl Core list Keywords: msgcat, convention Tcl-Version: 8.6 Tcl-Ticket: 3544988
This TIP proposes a mechanism for coupling locales more strongly to the names of the files that define them, an already-recommended practice, so as to make it less error-prone to produce message catalogs.
Current message catalog files are as follows:
Catalog file name:
Catalog folder: technically any, recommended: msgs in package main folder. Must be specified to the command mcload.
Catalog file contents: one command per translated item:
msgcat::mcset locale ori ?translation?
-de.msg- ::msgcat::mcset de Open Öffnen ::msgcat::mcset de Close Schliessen -eof-
The same locale value (de) is contained in the file name and in each mcset command.
This is technically unnecessary and error-prone. I found myself often copying message file contents from one language to the next and not setting the right locale in each mcset command.
The scope of this TIP is a new command similar to mcset which determines the locale from the file name.
IMHO it makes no sense to specify the locale of mcset commands and the locale in the file name different and thus separately.
mc file locale
The mc file locale is a locale specified by the file name of a message file.
Message catalogue file name: de_ch.msg
mc file locale: de_ch
The package msgcat maintains one value, mc file locale, with the following properties:
Its initial value is "" (the root locale).
Before a message catalog file is sourced by the procedure ::msgcat::mcload, the mc file locale is extracted from the message file name and stored as the current value.
The mc file locale may be querried by the command ::msgcat::mcconfig -mcfilelocale.
The mc file locale may also be set by the command ::msgcat::mcconfig -mcfilelocale value.
The original message filename may not be reconstructed by: [::msgcat::mcconfig -mcfilelocale].msg; there can be case differences.
The command ::msgcat::mcconfig is shared with . It has a new option -mcfilelocale.
There are two new commands:
::msgcat::mcflset source ?translation?
These work as:
::msgcat::mcset [::msgcat::mcconfig -mcfilelocale] source ?translation? ::msgcat::mcmset [::msgcat::mcconfig -mcfilelocale] list
The command name mcflset is an abreviation of: "message c'atalogue with **file locale set".
The example of the Rationale section above may now be written as:
-de.msg- ::msgcat::mcflset Open Öffnen ::msgcat::mcflset Close Schliessen -eof-
The locale value de only appears in the file name.
Further examples are in the tcl wiki msgcat page: http://wiki.tcl.tk/msgcat
See Tcl Feature Request 3544988. http://sourceforge.net/support/tracker.php/?aid=3544988
This document has been placed in the public domain.