This page gives guidelines to I18n for:
- Plugin developers who would like to apply the i18n mechanism in their own plugin, so that this plugin can be available in several languages
- People who would like to help the community by making the platform available in a new language
Although the basics of the i18n mechanism are the same for every part of the ecosystem, the packaging differs depending on what you are developing:
- Translations for the Sonar Platform: making the Sonar Platform available in a new language requires to develop and publish a new Language Pack plugin.
- By default Sonar embeds the English Pack.
- All other Language Pack plugins (like the French Pack plugin) are hosted in the Plugins Forge, are maintained by the community and are available through Update Center (category "Localization").
- Translations for the Sonar Community Plugins: open-source plugins of the Sonar Community (hosted in the Plugins Forge) must embed only the bundles for the default locale. Translations will be done in the Language Pack plugins.
- Translations for other Plugins: closed-source/commercial/independant plugins must embed the bundles for the default locale and the translations for every language they want to support.
To sum up
- Sonar Platform and Sonar Community Plugins rely on Language Pack plugins to get translations
- Other independant Sonar plugins embed by themselves all the translations they need
There are two types of files for localized messages:
- These are regular properties files with key/value pairs where you will put most translations
- These files must be stored in the package "org.sonar.l10n" (usually in the directory src/main/resources/org/sonar/l10n)
- The name of these files must respect the convention "<key of the plugin to translate>_<language>.properties", for example "technicaldebt_fr.properties" or "core_fr.properties". See sonar-packaging-maven-plugin for details on plugin key derivation.
Messages accept arguments. Such entries would look like:
- They are used for rule descriptions, which might be long and need HTML tags
- These files must be stored in the package "org.sonar.l10n.<plugin key>_<language>"
- Starting with Sonar 3.0, the files should be stored in the package "org.sonar.l10n.<key of the plugin to translate>_<language>.rules.<repository key>" (backward compatibility is ensured for l10n plugins which use the former location)
- The name of these files must be the key of the rule they translate
- Example: the French description of the Squid Architectural Constraint rule is "src/main/resources/org/sonar/l10n/squidjava_fr/ArchitecturalConstraint.html"
- Or, starting with Sonar 3.0: "src/main/resources/org/sonar/l10n/squidjava_fr/rules/squid/ArchitecturalConstraint.html" (as "squidjava" is the plugin key and "squid" the repository key)
In the Java API, properties files are supposed to be encoded in ISO-8859 charset. Without good tooling, this can be quite annoying to write translation for languages that do not fit in this charset.
This is why we decided to encode the properties files in UTF-8, and let Maven turn them into ASCII at build time thanks to native2ascii-maven-plugin (check the French plugin pom.xml). This makes the process of writing translations with a standard editor far easier.
HTML files must also be encoded in UTF-8.
Naming conventions for keys
Here are the conventions you have to know about keys:
Name of notification channel
Subscription to notification channel
Description of rule parameter
|Dashboard name, since 2.14.|
|Qualifier name, since 2.13.|
|Name of widget property|
|Description of widget property|
widget.hotspot_most_violated_rules.property.defaultSeverity.desc=If selected, severity used to initialize the dropdown list of widget
Any other widget message
Page names shown in the left sidebar
Any other keys used in a page
Category name of properties, since 2.11
Property name, since 2.11
Property description, since 2.11
Any other keys used by plugin
How to use localized messages ?
Ruby on Rails API
This API is used when implementing Ruby widgets or pages. It's really simple, a single method must be used :
Options are :
:defaultis the default value when the property key does not exist in bundles. If it's not set, then the key itself is returned.
:paramsis an array of string message arguments.
Of course the Rails framework provides other formatting methods like :
org.sonar.api.i18n.I18n is available for server extensions. Batch extensions are not supported yet and can not load bundles.
How to handle a Language Pack
A Language Pack defines bundles for the Sonar Platform and for the Sonar Community plugins.
Creating a new Language Pack
The easiest way to create a new pack is to copy the French Pack and to adapt it to your language.
Maintaining a Language Pack
Set the versions of the plugins that you want to translate in the pom file:
To check the missing key, run:
If the build fails, it means that some keys are missing. Go to target/l10n to check the reports for each bundle.
Missing keys are listed under 'Missing translations are:'
Each time you add a new bundle or you update an existing one, please create a JIRA ticket on the corresponding L10n component in order to track changes.
How to localize an independant plugin
This part applies if you are developing a commercial / closed-source plugin, or an open-source plugin that is not part of the Sonar Community Plugins.
Such plugins must embed their own bundles. Bundles must be added to src/main/resources with the following convention names :
- Standard messages : org/sonar/l10n/<plugin key>_<language>.properties
- Rule descriptions :
- Up to Sonar 3.0: org/sonar/l10n/<plugin key>_<language>/*.html
- Since Sonar 3.0: org/sonar/l10n/<plugin key>_<language>/rules/<repository key>/*.html
The default bundle is mandatory, and must be the English translation. For example the plugin with key "mysonarplugin" must define the following files in order to enable the French translation: