Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

DSpace supports a number of languages & you can even add your own translation.  This may also be referred to as Localization (l10n) or Internationalization (i18n).

Table of Contents

Multilingual Support on the Backend (REST API)

...

According to the languages you wish to support, you have to make sure that all the i18n related files are available. 

Where to find the message catalog

The latest English message catalog is part of the main DSpace distribution and can be found at: [dspace-source]/dspace-api/src/main/resources/Messages.properties

The different translations for this message catalog are being managed separately from the DSpace core project, in order to release updates for these files more frequently than the DSpace software itself. Visit the dspace-api-lang project on Github.

Where to edit the message catalog

In some cases you may want to add additional keys to the message catalog or changing the particular wording of DSpace concepts. For example, you may want to change "Communities" into "Departments". These kind of changes may get automatically overwritten again when you upgrade to the newest version of DSpace. It is therefore advised to keep such changes isolated in the following location: [dspace-source]/dspace/modules/server/src/main/resources/Messages.properties

After rebuilding DSpace, any messages files placed in this directory will be automatically included in the Server web application. Files of the same name will override any default files. By default, this full directory path may not exist or may be empty. If it does not exist, you can simply create it. You can place any number of translation catalogues in this directory. To add additional translations, just add another copy of the Messages.properties file translated into the specific language and country variant you need. 

For more information about the [dspace-source]/dspace/modules/ directory, and how it may be used to "overlay" (or customize) the default Server Webapp, classes and files, please see: Advanced Customisation

Localization of email messages

All email templates used by DSpace can be found in [dspace]/config/emails/

The contents of the emails can be edited and translated. 

Metadata localization

DSpace associates each metadata field value with a language code (though it may be left empty, e.g. for numeric values).

Localization of input-forms.xml

The display labels for input-forms.xml are currently not managed in the messages catalogs. To localize this file, you can create versions of this file in the same folders, appending _COUNTRY at the end of the filename, before the extension. For example, input-forms_de.xml can be used to translate the submission form labels in German.

Localization of license.default

The text in the default submission license (license.default) is currently not managed in the messages catalogs. It is translatable by appending _COUNTRY at the end of the filename, before the extension like for the localization of the input-forms.xml.

Multilingual Support on the Frontend (UI)

...