Availability
This routine is available starting with SIL Engine™ 4.5.8
Syntax
i18nText(baseDir, key, language)
Description
Returns the i18n text if the key can be resolved. Otherwise, the key itself will be returned.
Parameters
Parameter name | Type | Required | Description |
---|---|---|---|
baseDir | string | yes | The relative path to the properties files directory. The path is relative to cprime home. |
key | string | yes | Key for the i18ned message. |
language | string | yes | The language to use for the i18ned text. |
Returns
string
Example
If we have a directory called messages placed under the cprime home directory with the following properties files:
property file | content |
---|---|
messages.properties | com.mymessage.test.working = Deafulttest message. com.mymessage.test.inexistent.property.file = inexisting message. |
messages_en_UK.properties | com.mymessage.test.working = This function is working! |
messages_en_US.properties | com.mymessage.test.working = This routine is working as exepected! |
messages_fr_CH.properties | com.mymessage.test.working = Cette fonction fonctionne! |
messages_fr_FR.properties | com.mymessage.test.working = Cette routine fonctionne comme prévu! |
runnerLog("UK: " + i18nText("messages", "com.mymessage.test.working", "en_UK")); runnerLog("US: " + i18nText("messages", "com.mymessage.test.working", "en_US")); runnerLog("US: " + i18nText("messages", "com.mymessage.test.working", "en")); runnerLog("Test inexistent key: " + i18nText("message", "com.mymessage.test.inexistent.key", "en_US")); runnerLog("fr_CH: " + i18nText("messages", "com.mymessage.test.working", "fr_CH")); runnerLog("fr_FR: " + i18nText("messages", "com.mymessage.test.working", "fr_FR")); // if the property file does not exists, the value will be returned from the default properties file if exists runnerLog("Test inexistent property file: " + i18nText("messages", "com.mymessage.test.inexistent.property.file", "ro_RO"));
The results of the above code will be:
The properties files should match the folder name and had the properties extension.
See also