internationalization

Mobile Widgets offers a mechanism to internationalize your applications.

Internationalization files are store in i18n folder.
By convention, we use <language>.lng code for language files (it is a 2 character long code).
Example: en.lng, fr.lng, ...

Project tree

i18n folder: Internationalization folder. It contains all language files.
en.lng file: English translation.
fr.lng file: French translation.
And all other language files...

Language files contain pairs of <labelId>:<labelValue>.

<labelId> is the label identity.
<labelValue> is the label value.

Example:

about:about
aboutCopyright:Copyright (C) 2010 Orange
aboutReservedRights:All rights reserved.
accept:accept
close:close
message:this is my application
title:my application

Note:
By convention, lines are ordered by label identity.

In main scene file (main.wrl file), we add information about language files in languages properties of Inline node.
languages property contains an array of language prefix and language files for all supported languages.
use property define the default language (if current language is not supported by widget).
url property define the child scene. This child scene use the language preferences.

Note:
The scene that contains the Inline node with language information will not be internationalized itself. Only children scenes from this scene will be internationalized. That's why Inline node with language information should be the root scene of the project/widget.

Example:

#VRML V2.0 utf8
Inline {
  #Scene file
  url "helloworld.m4m"
  #For English, use the en.lng file
  #For French, use the fr.lng file
  languages [
    "EN" "en.lng"
    "FR" "fr.lng"
  ]
  #By default, we use the English language
  use ["auto", "EN"]
}

In widget, we can use the internationalized label via @[<labelId>:].
<labelId> is the label identity define in language files.
Example, to display the _Message_ label define in language file:

Shape {
  appearance Appearance { material Material2D { emissiveColor 0 0 0 } }
  geometry WrapText {
    string [ "@[Message:]" ]
  }
}

We cannot use directly internationalized label in Javascript code.
To use internationalized label, we define a field in Script node.
Syntax:

field SFString <myLabel> "@[<labelId>:]"

<myLabel> is a script field. It contains the internationalized label.
<labelId> is the label identity define in language files.

Example:

Script {
  #Store Message label in i18nLabel field
  field SFString i18nLabel "@[Message:]"
  url "javascript:
    function initialize() {
      #Display i18nLabel label in console
      Browser.print('message: ' + i18nLabel);
    }
  "
}