i18nText

Keep in mind that after modifying properties file you have to restart the Confluence.

Description

Returns the i18n text if the key can be resolved. Otherwise, the key itself will be returned.

Parameters

Parameter name

Type

Required

Description

Parameter name

Type

Required

Description

baseDir

string

yes

The relative path to the properties files directory. The path is relative to kepler 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 kepler home directory with the following properties files:

property file

content

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

messages_fr_CH.properties

messages_fr_FR.properties

The results of the above code will be:



The properties files should match the folder name and had the properties extension.



See also

Peacock