i18n (internationalization)

Many widgets have text fields that are displayed to the user. Any string attribute in the <options> node can be internationalized either by getText or by using special tags.

• No i18n

  <option>Welcome</option> <!-- Display no modification tho the screen -->
  

• I18n using getText

  <option>
      <domain>sampleFile</domain>  <!-- .po/.mo filename -->
      <key>i18n_welcome</key>      <!-- key in the .po file -->
  </option>
  

• Direct translatation using special tags

  <option>
      <fr_CA>Bonjour</fr_CA>
      <en_US>Welcome</en_US>
      <!-- Other languages -->
  </option>
  

Sample

i18n of the widget shortcut emptyText option is

• Not i18n option

  <shortcut>
      <name>MyShortcutWidget</name>
      <options>
          <field>hap_nm_top</field>
          <emptyText>Shortcut to top</emptyText>
      </options>
  </shortcut>
  

• Using GeoPrisma locale

  <shortcut>
      <name>MyShortcutWidget</name>
      <options>
          <field>hap_nm_top</field>
          <emptyText>
              <domain>sampleFile</domain>
              <key>i18n_shortcut_emptyText</key>
          </emptyText>
      </options>
  </shortcut>
  

• Direct translate

  <shortcut>
      <name>MyShortcutWidget</name>
      <options>
          <field>hap_nm_top</field>
          <emptyText>
              <fr_CA>Racourcie sur le top</fr_CA>
              <en_US>Shortcut to top</en_US>
              <!-- Other lang -->
          </emptyText>
      </options>
  </shortcut>