HOWTO: Upload Labels Translations in Nuxeo Studio (i18n)

This page is scheduled for review and update. Check back soon for updated content!

JSF UI Deprecation
This requires to have the JSF UI addon installed on your server that is deprecated since Nuxeo Platform LTS 2019.
Please refer to the Web UI documentation.

This page is about label translation for Nuxeo JSF UI. For Web UI labels, please refer to the page HOWTO: Manage Translations.

The Nuxeo Platform relies on standard i18n principles for translating text in the user interface. You need to upload a .properties file, suffixed with a four-letter locale code depending on the language you target. Studio allows you to upload .properties files to be deployed with the customization plugin. It's useful:

  • To translate new labels that appear in the plugin, such as form's fields name, lifecycle transition names, document type names, new vocabularies' labels, etc
  • To override existing labels definitions (when you want to change existing translations).

There are no naming rules for i18n keys: you can use the key format that is most convenient for you and use it directly in the .properties file.

To upload English translations for your plugin:

  1. Prepare a properties file named with keys and label values like this one. For instance, if you have a document type called "ProfessionalServiceProposal", you can add the following line:
    ProfessionalServiceProposal = Professional service proposal
    to a file like this: = Validation = Document Validated = Document Rejected
  2. In Studio Modeler, go to Resources and upload the file in the i18n files section.
  3. Repeat as needed with other languages, adding other files: (French), (Spanish), (Arabic), ... (take a look at How to Translate Nuxeo for a list of all the codes available)
  4. Update your Nuxeo instance with your Studio customizations.
a month ago GitHub Fix release date on deprecated addons
4 years ago Anahide Tchertchian 18 | emove warn about server restart: message bundles hotreload does work correctl
5 years ago Solen Guitter 17
5 years ago Manon Lumeau 16
5 years ago Manon Lumeau 15
5 years ago Alain Escaffre 14
6 years ago Solen Guitter 13
6 years ago Laurent Doguin 12
6 years ago Solen Guitter 11 | Added note on i18n key naming rules (no rule)
8 years ago Solen Guitter 9
8 years ago Solen Guitter 10 | Migrated to Confluence 4.0
8 years ago Arthur Gallouin 8
8 years ago Arthur Gallouin 7
9 years ago Darcy Carrié 6
9 years ago Stéfane Fermigier 5
9 years ago Solen Guitter 4
9 years ago Alain Escaffre 3
9 years ago Alain Escaffre 2
9 years ago Alain Escaffre 1
History: Created by Alain Escaffre

We'd love to hear your thoughts!

All fields required