Translating IDE and plugin texts used in UI, inspections, file templates, and other elements
Translations for IntelliJ Platform products and plugins can be provided in two ways:
This talk covers how to implement localization in JetBrains plugins. While JetBrains IDEs are available in Simplified Chinese, Japanese, and Korean, most plugins remain English-only. Joachim demonstrates how to easily localize different plugin elements like messages, settings, inspections, and file templates. The session also provides tips on localizing plugin descriptions for Marketplace, websites, or handbooks.
Localizing IDEs is achieved by providing language packs (see language packs provided by JetBrains). Language packs are IntelliJ Platform plugins containing translations of UI texts. Official language packs contain translations of all the UI texts used in the IDE and in plugins developed by JetBrains.
Note that language packs aim for full IDE localization. If it is required to translate a plugin, see the section.
Language packs must define their language. The language definition is provided in the plugin.xml file with com.intellij.languageBundle extension point (EP), for example:
plugin.xml
com.intellij.languageBundle
<extensions defaultExtensionNs="com.intellij"> <languageBundle locale="zh-CN"/> </extensions>
The locale attribute defines the translation language on two possible levels:
locale
zh-CN
zh-TW
ja
Note that com.intellij.languageBundle EP is internal and must be used by JetBrains only.
{style="warning"}
It is important to note that there is no language chooser in the IDE, and language packs serve as the IDE "language switcher." Installing a language pack changes the IDE language to the one defined by the languageBundle EP. Only a single language pack can be installed at the same time, and restart is required for the translations to take effect.
languageBundle
To get a current UI language set in the IDE, use DynamicBundle.getLocale().
DynamicBundle.getLocale()
See the translated elements list for the elements possible to translate. All the elements should be located in exactly the same paths as in original locations in their JAR files.
For example, if the original location of a message bundle is $PLUGIN_JAR$/messages/AbcBundle.properties, it must be located in $LANGUAGE_PACK_JAR$/messages/AbcBundle.properties.
In case of doubts, it is recommended to inspect the contents of existing language packs.
Note that bundled translations are in the experimental state.
The IntelliJ Platform partially supports providing translations directly bundled in the IDE or plugins. See the translated elements list for the elements possible to translate.
An IDE module or a plugin can provide multiple language translations in a single distribution, for example, zh-CN and ja. Proper localization files will be used at runtime depending on the IDE language.
Translations for a specific language can be organized in two ways as shown below. The proper directory layout/filename suffixes is the only thing needed for the translations to work. No additional actions like registering EPs are needed.
Translated resources are stored in a dedicated directory structure.
/localization/$LANGUAGE_CODE$/$REGION_CODE$ ($REGION_CODE$ level is optional).
$REGION_CODE$
Example:
Original template description:
/fileTemplates/code/JavaDoc Class.java.html
Translated template description:
/localization/zh/CN/fileTemplates/code/JavaDoc Class.java.html
Translated resources are stored in files with dedicated filename.
/intentionDescriptions/QuickEditAction/description_$LANGUAGE_CODE$_$REGION_CODE$.html
/intentionDescriptions/QuickEditAction/description.html
/intentionDescriptions/QuickEditAction/description_zh_CN.html
The following table contains the possible translated elements and information about their support in language packs and IDE/plugins.
(*.properties files)
Use DynamicBundle
DynamicBundle
(*.html files in /inspectionDescriptions directory)
(*.html files in /intentionDescriptions directory)
(*.html files in the /fileTemplates directory)
(*.xml file in /postfixTemplates directory)
(*.html files in tips directory)
See the IntelliJ Platform UI Guidelines | Text sections for good practices about writing UI texts.
Translations can be provided on three different levels:
In addition, translations can be organized in directories or with file suffixes, and the same translation can be provided by a language pack or IDE/plugin.
All these conditions determine how a single translation is resolved at runtime. The lookup order is as follows:
Translation file from the language pack.
Region level (for example, zh_CN, zh_TW) localization file:
zh_CN
zh_TW
{type="alpha-lower"}
Language level (for example, zh) localization file:
zh
Default file (no suffix) within the IDE or plugin (original English message).
Consider that the current IDE language is set to Simplified Chinese (zh_CN). To find an example messages/MyBundle.properties message bundle for this language, the locations will be searched in the following order:
