This page last changed on Jan 01, 2007 by don.willis@atlassian.com.

In Confluence version 2.2.10 and above it is possible to provide translations for the tooltips and labels in the Rich Text Editor.

Most of the editor's internationalised text consists of its tooltips. There are also a few labels such as those in the Image Properties dialog.

Unfortunately, translations of these to another language are not currently read from the ConfluenceActionSupport.properties file. Instead they are read from a collection of javascript files within Confluence's includes directory.

Rich Text Editor translations can not be installed as a language pack. Vote for CONF-6987 to get this fixed.
Incomplete Rich Text Editor translations result in the users seeing the "keys" for the missing translations, rather than falling back to another language.

Creating a new Translation

The Rich Text Editor provided by Confluence is Tiny MCE. The language files it uses are all within the confluence/includes/js/tiny_mce directory.
There are 7 files that need translating. They are located in 7 different directories and each english file is named "en.js". The translated files should be named with either a two letter language code or the combination of a two letter language and two letter country code.

The core editing strings are found in:

confluence/includes/js/tiny_mce/langs/en.js

Translations for most of these strings are included for a variety of languages. However, some of them may need to be re-encoded to UTF-8.

These two files:

confluence/includes/js/tiny_mce/themes/advanced/langs/en.js
confluence/includes/js/tiny_mce/plugins/table/langs/en.js

are also translated into the same languages. However some translations may be missing or out of date.

The remaining 4 files are all specific to Confluence and require translation for most or all languages:

confluence/includes/js/tiny_mce/plugins/confluence/langs/en.js
confluence/includes/js/tiny_mce/plugins/emotions/langs/en.js
confluence/includes/js/tiny_mce/plugins/fullscreen/langs/en.js
confluence/includes/js/tiny_mce/plugins/paste/langs/en.js

Using the Translations

Once you have translations for each file, you need to edit the locales-to-editor-languages.properties file located in confluence/WEB-INF/classes.
This file tells the Rich Text Editor which js files to use for a given language.

Example

Attached is a translation for US English. (Since tiny MCE is a US product the core text is all spelt in US English anyway, but there is one "Centre" in the Image Properties dialogue). It contains files named en_us.js in the required directories.

To add this translation to Confluence:

  1. Download and install the US English Language Pack Plugin provided here.
  2. Unzip the archive into the confluence/includes/js/tiny_mce directory.
  3. Add en_US=en_us to the locales-to-editor-languages.properties file.
  4. Restart Confluence.

To test the translation is working:

  1. Change your language to US English (Preferences -> Edit Profile -> General -> Preferred Languages
  2. Edit a page using the Rich Text Editor
  3. Click the Image icon
  4. Check that the Alignment dropdown contains "Center"

tiny_mce_langs_en_us.zip (application/x-zip-compressed)
Document generated by Confluence on Mar 22, 2007 21:00