Title

Localisable Parameters

Many procedures in the jstools library take parameters or options that can be localised. That means that the parameter, instead of being used or displayed directly, is a key which is looked up in a natural­language database corresponding to the user's preferred language, and the string found there is used instead of the key itself. (Such strings can also contain references to Tcl variables, preceded by `$', or the results of Tcl commands, enclosed in brackets, which will be substituted in the caller's context before the string is displayed.) These parameters are indicated by the word `localisable' (in parentheses, as a link to this document) in the procedure documentation.

If no string can be found in the database for a partiuclar key, the key itself is used as a default, so generally you can ignore the fact the a parameter is localisable if you want to.

More information about localisation is available in the following documents:

* The Language Database Mechanism

* jldb.tcl

* The jstools Global Preferences Panel