Internationalization and Localization

This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc.

Internationalization (sometimes referred to as i18n) is the process of designing software so it can be adapted to multiple languages and regions. Localization (or l10n) is the adaptation of software to a specific region or language.

This chapter explains how internationalization is implemented in Jenkins, as well as the tools to support both internationalization and localization.

Developer tasks

Plugin developers internationalize a plugin by modifying the Java files and the Jelly files in the plugin. They can significantly improve the translation experince by enabling Crowdin translation support for the plugin. The steps include:

  1. Internationalize messages in Java source code

  2. Internationalize messages in Jelly views

  3. Enable Crowdin translation support for the plugin (Optional)

Prepare a Java source file for localization shows the detailed internationalization steps for Java source files. Advanced localization provides guidance for additional internationalization, like date formatting, time formatting, and number formatting.

Translator tasks

The Jenkins project welcomes translations.

Translators can contribute to plugin localizations through Crowdin translations after the plugin has enabled Crowdin translation support. Crowdin simplifies translation work so that it focuses on the translation rather than the mechanics of pull requests and source files. Translators perform the following tasks with Crowdin:

  1. Translate messages in Crowdin

Translators can contribute to Jenkins core and plugins that are not registered with Crowdin by filing pull requests on GitHub. Translators need to perform the following tasks for Jenkins core and plugins that are not registered with Crowdin:

  1. Generate properties files and translate messages in properties files

  2. Translate help in HTML files

  3. Submit a pull request

Chinese localization

If you want to contribute Chinese localization, please create a PR in the Simplified Chinese Plugin. More details on the Chinese localization plugin are available from https://github.com/jenkinsci/jep/tree/master/jep/216/README.adoc.

IntelliJ IDEA plugin

Refactoring the existing code to handle i18n correctly is tedious. The Jenkins Development Support plugin for IntelliJ IDEA simplifies internationalization.

Install Plugin
References