Nuxeo Server

How to Upload Labels Translations in Nuxeo Studio (i18n)

Updated: December 5, 2017 Page Information Edit on GitHub

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 messages_en_US.properties 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:
    label.security.permission.validation.workflow.validation = Validation
    label.security.permission.validation.document.validated = Document Validated
    label.security.permission.validation.validation.rejected = Document Rejected
    
  2. Go to Resources and upload the file in the i18n files section.
  3. Repeat as needed with other languages, adding other files: messages_fr_FR.properties (French), messages_es_ES.properties (Spanish), messages_ar_SA.properties (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.
5 days ago Manon Lumeau Add tags for doc days
a month ago manonlumeau Added content-review-lts2017 label
2 months ago manonlumeau NXDOC-1346-FT review screenshot
3 years ago Anahide Tchertchian 18 | emove warn about server restart: message bundles hotreload does work correctl
3 years ago Solen Guitter 17
3 years ago Manon Lumeau 16
3 years ago Manon Lumeau 15
4 years ago Alain Escaffre 14
4 years ago Solen Guitter 13
4 years ago Laurent Doguin 12
5 years ago Solen Guitter 11 | Added note on i18n key naming rules (no rule)
6 years ago Solen Guitter 9
6 years ago Solen Guitter 10 | Migrated to Confluence 4.0
7 years ago Arthur Gallouin 8
7 years ago Arthur Gallouin 7
7 years ago Darcy Carrié 6
7 years ago Stéfane Fermigier 5
7 years ago Solen Guitter 4
7 years ago Alain Escaffre 3
7 years ago Alain Escaffre 2
7 years ago Alain Escaffre 1
History: Created by Alain Escaffre