Providing a Translated User Interface

Hyperscience does not provide translations, nor does it offer a translation-management system. To use this feature, you need to obtain translations outside of Hyperscience.

If you would like to offer a translated Hyperscience interface to your keyers and knowledge workers, a System Admin can upload a translation file for each of the languages you would like to make the interface available in.

The user experience

In v40, only the text that appears to users in the Data Keyer Staff and Knowledge Worker permission groups is available for translation. These areas of the application include the following:

  • Task Queue

  • Supervision tasks

  • QA tasks

  • Submissions

  • Documents

  • Cases

Users in the Data Keyer Staff and Knowledge Worker permission groups will have a fully translated user interface when they select one of the available languages from the drop-down menu with their name on it in the upper-right corner of the interface.

If users in other permission groups choose to view the interface in another language, translated text will appear only on those pages that are also available to Data Keyers and Knowledge Workers. Select pieces of text on other pages may also be translated. We plan on making more text available for translation in future versions of Hyperscience.

Supported locales

You can provide translations for the following locales in v40:

  • en-CA (English, Canada)

  • en-GB (English, Great Britain)

  • fr-CA (French, Canada)

  • fr-FR (French, France)

If you would like to provide translations for additional locales, contact your Hyperscience representative.

Creating and uploading a translation file

To provide a translated interface to your keyers and knowledge workers, a System Admin needs to create and upload a translation file for each language you want to translate the interface’s text into. They can do so by following these steps:

  1. On the Import/Export page (Administration > Import/Export), export the file containing the en_US (English, United States) text strings that are available for translation. For more information on exporting translation files, see Importing & Exporting Settings.

The file contains four columns:

  • Key — the internal key for the text string

  • value — the column where you will enter the translations

  • Description — contextual details to help your translators provide the most appropriate translations

  • value_en_us — the original text

  1. In the value column, enter the translations of the text in your chosen language and save the file. We support translations entered in the ICU format. More information about this format can be found in Formatting Messages in the ICU Documentation.

    • If you do not provide the translation for a string, the original text for that string will appear in the application.

    • While we do not limit the length of the text strings in the value column, we recommend keeping the length of each string to 1.5 times the length of the original string. If strings exceed that length, they may not appear as intended in the application.

Only edit the cells in the value column. Do not edit any of the other columns in the file or any of the column headers.

  1. On the Import/Export page, import the edited file, and select the locale code of your chosen language during the upload process.

Note that it is not currently possible to delete a translation file after you upload it.

Updating translations

A System Admin can update existing translations at any time.

  1. On the Import/Export page (Administration > Import/Export), export the file containing the translated text strings that you want to edit. You can identify each of the available files by its locale code.

    1. For more information on exporting translation files, see Importing & Exporting Settings.

  2. In the value column, edit or add translations and save the file.

Only edit the cells in the value column. Do not edit any of the other columns in the file or any of the column headers.

  1. On the Import/Export page, import the edited file, and select the locale code of the translations’ language during the upload process.

For more information on importing translation files, see Importing & Exporting Settings.

Text strings and product updates

As our user interface changes, we may update the text that appears in the application. When we update the interface’s text in areas of the application that can be translated, we also update the en_US translation file to include the new or edited strings. These strings appear in English in translated interfaces until you provide translations for them.

To obtain the latest set of strings, download the en_US translation file.