Page tree
Skip to end of metadata
Go to start of metadata


With the help of translation keys, you can translate almost any content in Confluence.

What is a language pack?

A language pack behaves like any other Confluence app. It is a pack of texts you translated. Every translation you create ends up stored in a language pack. Said language pack is then installed in Confluence and your translations becomes active.



How translations work in Linchpin

Linchpin Translate (part of Linchpin Manager) uses translation keys to translate content. Almost each element has an own translation key, and lucky for us, Confluence offers a relatively easy way to find out what the translation keys are.


To display translation keys in Confluence, add this parameter to the URL:

YOUR_CONFLUENCE/dashboard.action?i18ntranslate=on


To disable the translation keys again, change this parameter to =off:

YOUR_CONFLUENCE/dashboard.action?i18ntranslate=off


Alternatively, follow this link to find the documentation on how to get all relevant translation keys at once.



We strongly advise to avoid spaces in translation keys!

Linchpin Translations can encounter some errors when spaces are used in translation keys. Please avoid using spaces as good as you can.



Create a language pack

Navigate to Confluence administration → Linchpin Translations → Translate language pack.


Click on the three dots button  to open a context menu. Then, click on the + New project button. Give your project (language pack) a name and click on the Save button.


We advise to avoid spaces in project names. "UserProfiles" usually works better than "User Profiles".


Click on the New key input area at the bottom of the configuration screen. Enter the translation key here. Click on the + Add key button.


Then, click on the Locales button. Click on the first field to open a list of available languages. Select the language you want to translate into, then click on the plus button .

Repeat this step if you wish to translate the field name into multiple languages.

Click on the Close button or the X button to close this window.


Now, enter the translations into the correct fields. The languages will be displayed with the help of according ISO codes. For example, English would be en_US, German de_DE and so on.

Finally, click on the Save button. 


Add as many keys and translations as you wish. 

At the end, click on the Install button.



If your translation key changes to undefined after you hit save, please enter the key again.

Sometimes this error might occur, but you will solve it when you re-enter the field name and click on the Save button again.


Now your new language pack is installed and active.




Important notice regarding translation keys

Please do not use the same word for the translation key and the translation.

Translations won't work when the translation key uses the same word as the translation. This is especially important when translating profile field names/field labels.



Example

Let's say you wish to translate a profile field called Street. Street is the field label and at the same time the translations key.

You create 6 translations:

en_US: Street

en_GB: Street

de_DE: Straße

es_ES: Calle

fr_FR: Adresse

pt_BR: Rua



Users who use en_US or en_GB as their language will see Straße as the field label.



This happens because Linchpin Translations ignores any translation that exactly matches the translation key and takes the next best translation. In this case Straße was the first available translation that did not exactly match the translation key.


We are investigating this issue. As a current workaround, please make sure that your translation keys are unique.

You could, for example, call the "street" field label "streetKEY" and then create English translations with the proper name "street".