Translation keys

Learn how to translate Jira Customer Portal components with keys

Translation keys are used to indicate and translate entire components that are native for the customer portal. The keys automatically get original texts from the project configuration. It’s a more efficient alternative to manually inserting whole paragraphs to be translated.

Currently available keys

Announcement banner on the native Help Center page

Announcement banner on the native Customer portal

Field name and description on the Customer portal

Welcome message (Introduction text in Project settings)

Example

The original text configured under Portal settings → Introduction text (welcome message):

Welcome to the Atlassian Team portal.  Please note that our team is now responsible for the following products:  _Jira, Confluence, Bitbucket, GFDT (Tempo Timesheets, Tempo Teams, Tempo Planner, RTI Report) and Initiative Sheets._ \\ \\ 👉 +For requests regarding other products, please refer to the+ *[Jira Service Desk NBC Portal|https://jira.bnc.ca/servicedesk/customer/portals]*.👈 \\ ⇨ [{color:red}Catalogue de formation Atlassian (GRATUIT)! | Atlassian Training Catalog (FREE)!{color} |https://training.atlassian.com/free-training-catalog]

Translation key configured under Project settings → Translation:

$.portal[key=isd].description

Translation value (in French):

Bienvenue sur le portail de l'équipe Atlassian.  Veuillez noter que notre équipe est maintenant responsable des produits suivants: _Jira, Confluence, Bitbucket, GFDT ("Tempo Timesheets", "Tempo Teams", "Tempo Planner", Rapport RTI) et les Fiches Initiatives._ \\ \\ 👉 +Pour demandes concernant toutes autres produits, veuillez-vous référer au+ *[Portail BNC _Jira Service Desk_|https://jira.bnc.ca/servicedesk/customer/portals]*.👈 \\ ⇨ [{color:red}Catalogue de formation Atlassian (GRATUIT)! | Atlassian Training Catalog (FREE)!{color} |https://training.atlassian.com/free-training-catalog]

With the above configuration, the welcome message translates correctly in both languages:

English

French

Using translation keys

You can use the keys above the same way you insert typical translations in the app.

Steps

1. In Project settings, choose Translation.
2. Click Add translation.
3. Select the language you want to translate to.
4. Insert one of the keys given above.
5. Optionally, check the Shared checkbox to apply the translation in all service projects.
6. Click Add.

Result

The translation is added and displayed to any user who selects the chosen language.

Keys from Theme Extension

If you have the Theme Extension app installed on your instance, you can translate the Announcement banner and Footer elements if they’re applied to your style. To do so, get the translation keys on each element’s configuration panel.

Steps

1. To get the translation key from the site with an applied theme, go to the theme editor in the Theme Extension app.
2. In the Elements section, select either announcement banner or footer.

   

3. On the configuration panel, click Get a key.

   

4. Copy the key.

   

   Note

   Be sure to copy the entire key, with all its HTML selectors. Otherwise, the translation will not work properly.

5. Insert the key to the Translation configuration.
6. Click Add.

   

Result

The translation is added.