HOWTO: Upload Labels Translations in Nuxeo Studio (i18n)

Updated: July 11, 2024

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.