guide/guidelines/internationalization.md

3 The OpenBMC Web UI implements internationalization and separates the language-
8 - [Vue I18n](https://kazupon.github.io/vue-i18n/introduction.html)
14 - Page specific labels should be nested in an object with a key prefixed `page`
17   - e.g. `pageLocalUserManagement.editUser`
18 - Any 'major' child components should be nested inside page specific objects
20   - e.g. `pageEventLogs.table.eventType`
21 - Avoid any complex linked locale messages.
22 - Alphabetize object keys. This helps in locating the keys.
23 - We use the `$t()` function in markup and `this.$t` in scripts (which Vue I18n
28 - A new `src/i18n.js` file is added and it registers Vue I18n as a plugin to our
30 - The CLI creates a `src/locales/en-US.json` file, which contains our default
32 - The keys are placed in the `src/locales/en-US.json` file and then the `$t()`
34 - After adding or removing calls to `$t` please run this to ensure consistent
39 node node_modules/vue-i18n-extract/bin/vue-i18n-extract.js -v 'src/**/*.?(js|vue)' -l 'src/locales/…
42 - If you're working on updating a translation for another language (e.g.
47 node node_modules/vue-i18n-extract/bin/vue-i18n-extract.js -v 'src/**/*.?(js|vue)' -l 'src/locales/…
57 <page-section :section-title="$t('pageDumps.dumpsAvailableOnBmc')">
60 - Vue I18n’s `$tc()` function can help with displaying plurals.
61   [Learn more about pluralization.](https://kazupon.github.io/vue-i18n/guide/pluralization.html)
74    cancelTitle: this.$t('global.action.cancel'),
79 ## Vendor overlays (environment-specific translations)
81 To keep the base translation files vendor-neutral, vendor-specific strings live
84 - Place shared vendor strings in the vendor root folder (e.g.,
86 - Place project-specific overrides in the variant folder when needed (e.g.,
87   `src/env/locales/vendor-variant/`)
88 - Merge order at runtime:
89   1. Base locales from `src/locales/` (auto-discovered)
91   3. Variant overlays (e.g., `src/env/locales/vendor-variant/`)
92      - Variant keys overwrite vendor root keys on conflict
96 - All JSON files under `src/locales/` are bundled automatically.
97 - All JSON files under `src/env/locales/` that match the active environment are
99 - If multiple vendor projects share strings, prefer the vendor root folder so
102 Example: moving vendor-only dump type labels
105 // src/locales/en-US.json (base)
112 // src/env/locales/nvidia/en-US.json (overlay)
129 - `en` → `en-US`
130 - `ru` → `ru-RU`
131 - `zh` → `zh-CN`
132 - `ka` → `ka-GE`