Skip to end of metadata
Go to start of metadata

Beginning with Profound Version 5, Fix Pack 5.0, all Atrium messages or strings are configurable for different languages or cultures.  You can customize these strings yourself, or even define new languages with configuration options.

Configuring a Language

Settings File

To configure language support for Atrium, create a new settings.js file and place it in the following IFS directory:

Replace "yourInstanceName" with the name of the Profound UI instance that was chosen during installation. Usually the name is "profoundui", in which case the path would be /www/profoundui/htdocs/profoundui/userdata/extension/atrium/.

The configuration options set in the Atrium settings.js file apply only to Atrium. If you want to configure languages for Genie or Rich Display sessions, see Language Support.

Settings

To set the language, specify a value for pui.language in your Atrium settings file. For example, to set the language to "French, France", you would code the following:

The following languages are provided with Atrium:

  • en_US = English, USA  (default)
  • en_UK = English, UK
  • de_DE = German, Germany
  • pt_PT = Portuguese, Portugal
  • pt_BR = Portuguese, Brazil
  • es_ES = Spanish, Spain
  • es_MX = Spanish, Mexico
  • fr_FR = French, France
  • fr_CA = French, Canada
  • it_IT = Italian, Italy
  • nl_NL = Dutch, Netherlands

Setting pui["language"] is all that's necessary for Atrium to provide text or messages in the language of your choice. (Note: not all messages and strings have been translated for every language yet. For those not yet translated, you can define them yourself as shown below.)

Customizing a Language

Any of the strings that are provided in the language dictionary of Atrium may be customized. To do that, you can define a string as follows:

For example, to customize the message that occurs when there's no connection to the server in USA English you can code:

This can be set separately for each language.  For example, in German you might prefer:

You can find a list of the possible dictionary and message id values under "Defining a new language", below.

Defining a New Language

If Atrium does not come with your preferred language already defined, you can add a new language yourself by coding all of the needed strings as configuration settings. To do that, your settings file should set the language you wish to use.  You can pick any string you like for the language name. Then, define empty objects for the runtimeMsg and runtimeText dictionaries, as follows:

Then, define a message for each message ID in each dictionary.  Here is a list of all of the messages you can define:

 

You should only translate the text on the right-hand side of the equal sign.  Do not translate the message IDs (such as "no connection message" or "signature overflow") because Profound UI will not be able to find your message in the dictionary if you change the dictionary name or the message id.

Strings like "&1", "&2", etc. are placeholders. The translations of such strings should also include the placeholder symbols.

Some strings not listed above may be specified in the general Profound UI language support page: Language Support. To change a string that is used by both Atrium and Profound UI, the string needs to be set in both the Atrium settings file and the Profound UI settings.js file.

Labels
  • No labels