Files
SCM-Manager/docs/v2/i18n for Plugins.md
2020-03-09 08:01:43 +01:00

1.0 KiB

How to internationalize your own plugin

Create the plugins.json file

The translation file for plugins should be stored in the resources path locales/{lang}/plugins.json

All translation keys are parts of a **unique root key**. It is recommended to **use the maven artifactId of the plugin as root key** to avoid conflicts with other plugin. All translation files would be collected and merged to a single file containing all translations. Therefore it is **necessary to use a unique root key** for the translations.

//**example:**//

the translation file of the svn plugin is stored in locales/en/plugins.json

Usage in the own React components

SCM-Manager use react-i18next to render translations.

The following steps are needed to use react-i18next in the own components

  • import react-i18next

  • declare the translation method as property

  • wrap the react component with the translate method and give the json translation file name "plugins"

  • use the translation keys like this: