Localization Properties File

The localization properties file is encoded in standard ASCII. All non-ASCII character values from the device application file will be converted to escaped Unicode hexadecimal values before writing to the properties files. The resource keys in the properties file are grouped into four sections:

Global – anything that is global in the device application file. Currently, only the ribbon name.
Flow – the flow of the screens
Screen – the screens contains widgets, menu items, and actions.
Meta – meta info such as variables, images, styles, connection profiles, and mobile business objects.

Syntax

Variable assignment:

#####################################################
## Global
#####################################################
RibbobName=myBob

#####################################################
## Flow
#####################################################
Screen.1.name=Customer
Screen.2.name=Client
Screen.3.name=About
Connection.1.2.ALERT.INFO.ok_label=OK
Connection.2.1.ALERT.INFO.ok_label=OK

#####################################################
## Screen Id 1 (Customer)
#####################################################
Screen.1.Display.Button.1.name=Submit
Screen.1.Display.Button.1.Action.0.required_message=Input {0} is required.
Screen.1.Display.Button.2.name=Cancel
Screen.1.Menu.2=Submit
Screen.1.Menu.2.Action.0.required_message = Input {0} is required.
Screen.1.Menu.3=Cancel

#####################################################
## Screen Id 2 (Client)
#####################################################
Screen.2.Display.Label.1.name=Name
Screen.2.Display.Label.2.name=Sex

#####################################################
## Screen Id 3 (About)
#####################################################
Screen.3.Display.StockProperties.ABOUT_SCREEN_CLOSE_MENU_LABEL=Close
Screen.3.Display.StockProperties.ABOUT_SCREEN_DESCRIPTION=Description
Screen.3.Display.StockProperties.ABOUT_SCREEN_FLASH_ALLOWCATED_LABEL=All
Screen.3.Display.StockProperties.ABOUT_SCREEN_FLASH_FREE_LABEL=Freeds
Screen.3.Display.StockProperties.ABOUT_SCREEN_FLASH_OBJECTS_LABEL=Flashs
Screen.3.Display.StockProperties.ABOUT_SCREEN_RAM_ALLOWCATED_LABEL=RAM
Screen.3.Display.StockProperties.ABOUT_SCREEN_RAM_FREE_LABEL= RAM freed
Screen.3.Display.StockProperties.ABOUT_SCREEN_RAM_OBJECTS_LABEL=RAM objs
Screen.3.Display.StockProperties.ABOUT_SCREEN_VERSION_LABEL=Version

#####################################################
## Meta Info
#####################################################
VariableReferences.1.name=New Variable
VariableReferences.1.description=This is a new variable
StyleReferences.1.name=New Style
StyleReferences.1.description=This is a fancy style

Examples

Ribbon name

The resource key for the ribbon name must be defined as ribbon_name:

ribbon_name=myBob

Alerts

Currently only alert in flow contains localizable strings. Resource keys for alert can be defined as {ConnectionType}.{sourceScreen}.{targetScreen}.{connectionSubType}.{attrName}. For example, the OK label of an information alert from screen 1 to screen 2 would look like:

ALERT.Screen.1.Screen.2.INFO.ok_label

Screen widgets

Resource keys for screen widgets can be defined as {screen}.{widget}.{attributeName}. For example, a button with the ID of 1 in screen 1 would look like this:

Screen.1.Button.1.name

Stock properties

For stock properties the keys would look similar to:

{screen}.StockProperties.{stockProperty} .{attributeName }

Labels

The resource key for the About screen close menu label can be defined as:

Screen.1.StockProperties.ABOUT_SCREEN_CLOSE_MENU_LABEL.value

Menus

Resource keys for menus can be defined like this:

{screen}.{menuItem}.{attributeName }  e.g. Screen.1.Menu.2.name

Variables

Resource keys for variables are formatted as {variable}.{attributeName}, for example:

VariableReferences.1.display_name, VariableReferences.1.description