Internationalization

The OpenBMC Web UI implements internationalization and separates the language- specific parts of the interface from the rest of the code, so they can be easily replaced. The OpenBMC Web UI uses the following library for internationalization:

• Vue I18n

Key naming convention

The OpenBMC Web UI follows the following key naming conventions:

• Page specific labels should be nested in an object with a key prefixed page followed by the page title. Formatting in this manner provides a systematic structure and improves readability of the language file.
  • e.g. pageLocalUserManagement.editUser
• Any 'major' child components should be nested inside page specific objects (ex. table, modal)
  • e.g. pageEventLogs.table.eventType
• Avoid any complex linked locale messages.
• Alphabetize object keys. This helps in locating the keys.
• We use the $t() function in markup and this.$t in scripts (which Vue I18n provides to our components) for outputting translation messages.

Using the Vue I18n plugin

• A new src/i18n.js file is added and it registers Vue I18n as a plugin to our Vue instance via the Vue.use() function.
• The CLI creates a src/locales/en-US.json file, which contains our default translation messages.
• The keys are placed in the src/locales/en-US.json file and then the $t() function is used to output the translation messages.
• After adding or removing calls to $t please run this to ensure consistent English translation (note: using variable expansion in key names is not handled automatically, you need to manually check them):

node node_modules/vue-i18n-extract/bin/vue-i18n-extract.js -v 'src/**/*.?(js|vue)' -l 'src/locales/en-US.json'

• If you're working on updating a translation for another language (e.g. Russian), run this to see the omissions (as well as cruft) and add the necessary keys automatically:

node node_modules/vue-i18n-extract/bin/vue-i18n-extract.js -v 'src/**/*.?(js|vue)' -l 'src/locales/ru-RU.json' -a

"pageDumps": {
  "dumpsAvailableOnBmc": "Dumps available on BMC"
}

<page-section :section-title="$t('pageDumps.dumpsAvailableOnBmc')">

• Vue I18n’s $tc() function can help with displaying plurals. Learn more about pluralization.

"modal": {
  "deleteDump": "Delete dump | Delete dumps"
}

this.$bvModal
  .msgBoxConfirm(this.$tc('pageDumps.modal.deleteDumpConfirmation'), {
   title: this.$tc('pageDumps.modal.deleteDump'),
   okTitle: this.$tc('pageDumps.modal.deleteDump'),
   cancelTitle: this.$t('global.action.cancel'),
   autoFocusButton: 'ok',
  })