Rate this page:
If you would like to translate Confluence into your local language, follow the instructions below on creating a language pack plugin from an example.
The Confluence community is sharing their in-progress and complete translations. You should check that a shared translation to your target language has not already been started here.
Start by checking out the technical overview of a Language Pack Plugin. Once you are familiar with the structure and content of a plugin, you can move on to creating your own:
<CONFLUENCE-INSTALL-DIRECTORY>
called languages
This example will work from an example plugin en_AU.zip. (or better: UPDATED Confluence 3.2 ConfluenceActionSupport.properties )
<CONFLUENCE-INSTALL-DIRECTORY>/languages
called en_AU.
Note that is the file is just a renamed copy of default English properties fileconfluence\WEB-INF\classes\com\atlassian\confluence\core\ConfluenceActionSupport.properties
file to the example plugin directory src\etc\com\atlassian\confluence\core
.ConfluenceActionSupport_en_AU.properties
file, and rename ConfluenceActionSupport.properties
to ConfluenceActionSupport_en_AU.properties
.Locate the plugin descriptor file, ConfluenceActionSupport properies file and flag image
1 2 3
<CONFLUENCE-INSTALL-DIRECTORY>/languages/en_AU/src/etc/atlassian-plugin.xml
<CONFLUENCE-INSTALL-DIRECTORY>/languages/en_AU/src/etc/com/atlassian/confluence/core/ConfluenceActionSupport_en_AU.properties
<CONFLUENCE-INSTALL-DIRECTORY>/languages/en_AU/src/etc/templates/languages/en_AU/en_AU.png
Detemine your language plugin key <KEY> using your country and locale according to the Language Module guide
atlassian-plugin.xml
to contain the relevant <KEY> and other references, including image type. Refer to the first section from the above Language Module for help on deciding what to modifyRename the directory structure and filenames that contain en-AU to your own <KEY>. The directory should now appear as
1 2 3
<CONFLUENCE-INSTALL-DIRECTORY>/languages/<KEY>/src/etc/atlassian-plugin.xml
<CONFLUENCE-INSTALL-DIRECTORY>/languages/<KEY>/src/etc/com/atlassian/confluence/core/ConfluenceActionSupport<KEY>.properties
<CONFLUENCE-INSTALL-DIRECTORY>/languages/<KEY>/src/etc/templates/languages/<KEY>/<KEY>.png
NOTE: You are now ready to build the plugin with the default English text to check that your setup is are correct. These next few steps deploy the default English version of the pack under your own language
From the command line, go to <CONFLUENCE-INSTALL-DIRECTORY>/languages
and execute
1
ant -Dlanguage=<KEY> build
Copy <CONFLUENCE-INSTALL-DIRECTORY>/plugins/<KEY>/dist/languages-<KEY>.jar
to <CONFLUENCE-INSTALL-DIRECTORY>/confluence/WEB-INF/lib
To collaborate on the translation process, you may wish to upload your translation to the Community Translations page. Repeat these instructions to test each iteration of your translation attempt.
\confluence\WEB-INF\classes\com\atlassian\confluence\core
directory. Copy the ConfluenceActionSupport.properties
file there into the translation_tool
directory and rename it to ConfluenceActionSupport_en.properties
.translation_tool
directory and remove any country variant from the filename, eg ConfluenceActionSupport_ru_RU.properties
becomes ConfluenceActionSupport_ru.properties
.Call the translation tool to create the spreadsheet file. For example, to create a Russian translation, open a terminal window in the translation_tool
directory and call
1
java -jar excelbundle.jar -export translation_ru.xls -l en,ru -r "%cd%"
Edit the file content, referring to Translating ConfluenceActionSupport Content for more information on how to modify the string values.
Call the translation tool to export the updates back into the localised properties file. For the example Russian translation, open a terminal window, go to the translation_tool
directory and call
1
java -jar excelbundle.jar -import translation_ru.xls -l ru -r "%cd%"
Once you have completed editing, you must copy and rename the localised translation back to the language plugin directory. For frequent updates, you may wish to create a script to do this.
To build the new language pack plugin, execute Ant in the confluence\src\etc\languages
directory:
1
ant -Dlanguage=<LANGUAGE> build
A JAR will be created in the languages/<LANGUAGE>/dist/
folder.
To install the translation in another instance of Confluence.
languages-<KEY>.jar
into the <CONFLUENCE-INSTALL-DIRECTORY>/confluence/WEB-INF/lib
of your target installationIf you would like to share your completed translation with other Confluence users, you can upload it here.
By providing Atlassian permission to bundle complete translations with the Confluence install you will soon be able to select your local language from the Confluence translations list under System Administration, without needing to package it as a plugin.
Rate this page: