Updated i18n functionality requires FarCry 4.1. |
The webtop and COAPI (meaning all forms that use formtools) have been updated so that every label is translated. |
Webtop and form assets will be hooked into the resource bundles automatically, but when you need to do that in your own code you use these methods.
Argument |
Description |
Default Value |
---|---|---|
key |
The key being requested |
For consistency should be in the form category.subcategory.item@attribute, e.g. myplugin.thatform.thisdescription@text |
default |
The default value (used if the key isn't found) |
The key string |
Argument |
Description |
Default Value |
---|---|---|
rbString |
The key being requested. Not changed to key for backwards compatability |
See getResource |
substituteValues |
Either a simple value to replace one value or an array to replace several. Variables defined in the resource string as {1} ... {n} |
The key string |
default |
The default value (used if the key isn't found) |
The key string |
Previously the webtop was translated by setting the label attribute in the xml to a variable (refering to the resource bundle struct in memory). With the refactoring, the label attribute is used to specify the DEFAULT VALUE. If the menu item has no corresponding resource, the default will be used. If it does it will be translated. This process also applies to the Inline Documentation feature.
By default the menu item is mapped to a resource key in the format webtop.sectionid.subsectionid etc. The attribute is then added to this base key to differentiate it from other translated attributes. e.g. webtop.sectionid.subsectionid@label.
The base key used for a menu item can be overridden by setting the rbkey attribute. This means that if you have an equivelent item in two places on your webtop you can override one to refer to the other. NOTE: this is not recommended - context is a significant factor when translating.
Translations of type, rule, and form text can currently be accessed through various i18n methods. In most cases these won't be necessary as all formtool tags are now automatically translated.