Internationalising Confluence Plugins

Text in Confluence plugins can be internationalised to cater for a variety of locales or languages. To do this, you will need to create a translated copy of the properties file(s) for each plugin and bundle these inside your language pack plugin. Having a properties file in each plugin allows plugin authors to provide internationalised plugins without having to add their i18n keys to Confluence's core source.

Confluence comes bundled with a few plugins that are stored in a file called atlassian-bundled-plugins.zip. The basic process for translating a plugin is:

  1. Extract this zip to a directory
  2. Extract the plugin JAR
  3. Locate the properties file which contains i18n keys (examples are below)
  4. Copy this file to the same location in your plugin. For example, if it is in path/to/file.properties, it needs to be in the same place in your language pack JAR with a locale extension: path/to/file_jp_JP.properties
  5. Repeat this for all plugins that can be internationalised

Below is a list of bundled plugins that can be internationalised and the properties file you will need to translate (correct as of Confluence 2.7):

Plugin Name

Filename

I18N Resources

Usage Statistics Plugin

usage-tracking-plugin-<version>.jar

resources/stats/usage.properties

Atlassian Plugin Repository

atlassian-plugin-repository-confluence-plugin-<version>.jar

resources/i18n/repository-templates.properties

resources/i18n/repository-macros.properties

Clickr Theme

clickr-theme-plugin-<version>.jar

clickr.properties

Mail Page Plugin

mail-page-plugin-<version>.jar

resources/mailpage.properties

Social Bookmarking Plugin

socialbookmarking-<version>.jar

com/atlassian/confluence/plugins/socialbookmarking/i18n.properties

WebDAV Plugin

webdav-plugin-<version>.jar

com/atlassian/confluence/extra/webdav/text.properties

Charting Plugin

chart-plugin-<version>.jar

chart.properties

TinyMCE (Rich Text) Editor

atlassian-tinymce-plugin-<version>.jar

com/atlassian/confluence/extra/tinymceplugin/tinymce.properties

Advanced Macros

confluence-advanced-macros-<version>.jar

resources/com/atlassian/confluence/plugins/macros/advanced/i18n.properties

Dashboard Macros

confluence-dashboard-macros-<version>.jar

resources/com/atlassian/confluence/plugins/macros/dashboard/i18n.properties

Below are the system plugins (found in confluence/WEB-INF/lib/) that can be internationalised and the properties file you will need to translate:

Plugin Name

Filename

I18N Resources

Information Plugin

confluence-information-plugin-<version>.jar

information.properties

Layout Plugin

confluence-layout-plugin-<version>.jar

layout.properties

Livesearch Plugin

confluence-livesearch-plugin-<version>.jar

livesearch.properties

Dynamic Tasklist Plugin

confluence-dynamictasklist-plugin-<version>.jar

dynamictasklist.properties

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport