Elvis 5 supports various languages in which the client applications can be run.
This article explains how to manage these languages. The following topics are described:
Supported languages
The following table shows the supported languages for each Elvis 5 client.
Note: Languages that are not supported or that are not listed can be added manually, see Customizing languages.
| Language | Code | Desktop client | Pro client | Brand portal |
|---|---|---|---|---|
| American English (default) | en_US | X | X | X |
| Chinese traditional | zh_TW | X | X | X |
| Chinese simplified | zh_CN | X | X | X |
| Dutch | nl_NL | X | X | X |
| German | de_DE | X | X | X |
| Finnish | fi_FI | X | - | - |
| French | fr_FR | X | X | X |
| Italian | it_IT | X | X1 | X1 |
| Japanese | ja_JP | X | X | X |
| Korean | ko_KR | X | X1 | X1 |
| Polish | pl_PL | X | X1 | X1 |
| Portuguese Brazilian | pt_BR | - | X1 | X1 |
| Russian | ru_RU | X | X1 | X1 |
| Spanish | es_ES | X | X | X |
| Thai | th_TH | X | - | - |
| Turkish | tr_TR | X | - | - |
1 Requires Elvis 5.21 or higher.
Configuring the client applications
Users choose the language in which they want to use the client application from a list on the Sign In screen.
Figure: Choosing a language in the Pro client.
Adding languages to or removing languages from this list is done by configuring the cluster-config.properties.txt file.
Configure the following settings by only adding those languages that should appear in the list. For each language, add its code. Multiple languages are separated by a comma. (For an overview of the language codes, see the table above.):
- For the Desktop client: supportedLocales
Example: supportedLocales=en_US, de_DE, es_ES, fi_FI, fr_FR, it_IT, ja_JP, ko_KR, nl_NL, pl_PL, ru_RU, th_TH, tr_TR, zh_CN, zh_TW
- For the Pro client and Brand portal: proClientsupportedLocales
Example: proClientSupportedLocales=en_US, de_DE, es_ES, fr_FR, it_IT, ja_JP, ko_KR, nl_NL, pl_PL, pt_BR, ru_RU, zh_CN, zh_TW
Customizing languages
When a language is not available or when existing text needs to be modified (for example to match terminology used in your workflow), then languages can be customized.
Language files
This is done by setting up a file containing text that should overrule the default text. Different files are used for the different client applications and for each of these files, a dedicated file for each language is used.
The naming convention of these files is as follows:
bundle code_language code.properties
The following bundle codes are available:
- acm: for the Desktop client
- cmn: for common text used by all clients
- lvs: for the Pro client and Brand portal
- web: for the Basic Web client (deprecated since Elvis 5.9)
|
Example: The following file contains custom text in English for use in the Desktop client: acm_en_US.properties |
For each file, refer to the property that holds the default text and specify the new text.
|
Example: Here, the English Enterprise term 'Issue' is replaced by 'Book' in the Desktop client: field_label.sceIssue=Book |
Location of the files
Language files that should overrule the default text are stored in the following location:
<Elvis Server>/Config/messages/
Where to get the references from
An overview of all default text with the names of their property is available in an Excel file named 'messages'. Contact WoodWing Support for the most recent version of this file.
The file contains the following columns:
- bundle. Holds the bundle code.
- key. Holds the property to refer to.
- en_US, de_DE, es_ES, and so on. Holds the translation for the text.
Note: When opening the file in Excel and the text is not displayed correctly, try different types of fonts. For example, the font for Chinese is set to 'Arial Unicode MS'.
Setting up a new language file
Step 1. Create a new file in the following location. In the file name, include the required bundle code and language code (see Language files above).
<Elvis Server>/Config/messages/
Step 2. In the file, add all required properties and the text to use for each property.
|
Notes:
|
Step 3. Make sure that the language is configured in Elvis Server so that it appears in the list for the user to choose. See Configuring the client applications above.
Tip: Test the new translations on a test server first to verify if everything is displayed and translated correctly.
Alternative method
As an alternative method, it is also possible to make the changes in the Excel file (such as by adding a new column for a new language) and sending that file to WoodWing (use e-mail support@woodwing.com and please mention which language you have added or modified). WoodWing will then generate the new language files and send them back to you for implementation.
About customizing a language
Keep the following in mind:
- Be consistent in your writing style and the use of terminology
- Do not remove any trailing spaces or special characters (such as : or , )
- Do not add spaces or special characters at the end of a line (including . or ; )
- The characters \n are used to add a line break in a message, do not remove these
- The numbers between curly brackets such as {0}, {1}, {2} and so on, are place holders for live data from the server. The text that is used is different per message. Do not remove or change these curly brackets and their numbers.
|
Example: The following text is used for showing the progress of uploading a number of files: Uploading in progress... {0} / {1} {0} is replaced by the current file number that is being uploaded, {1} is replaced with the total number of files that are uploaded. Here, the text shows that the second out of four files is being uploaded: Uploading in progress... 2 / 4 |
Additional configuration
The language files can also be used for configuring the following:
- Content of Shared Files e-mails
- Display method of values shown in metadata
- Display method of dates shown in metadata
Custom e-mail messages for shared files
When the Desktop client is used to share files with someone, that person is sent an e-mail. The content of that e-mail can be customized and/or translated.
To modify the content of the default e-mail, add the following options to the language file and set the desired content in the acm bundle:
email.Share.email_subject=Elvis link: {0}
email.Share.email_body.part1.description=Description: {0}\n\n
email.Share.email_body.part2.links_normal=Open the following URL in your Web browser to view files in Elvis. This link will remain valid until {0} ({1}):\n\n{2}\n\nIf you have a user account and have the Elvis Desktop client installed on your machine, click the following link:\n\n{3}
email.Share.email_body.part2.links_upload=Open the following URL in your Web browser to view files in Elvis and to upload new ones. This link will remain valid until {0} ({1}):\n\n{2}\n\nIf you have a user account and the Elvis client is installed on your machine, click the following link:\n\n{3}
email.Share.email_body.part2.links_approval=Open the following URL in your Web browser to view the files in Elvis to add your approval or rejection. This link will remain valid until {0} ({1}):\n\n{2}\n\nIf you have a user account and the Elvis client is installed on your machine, click the following link:\n\n{3}
When users upload files to a Shared link or apply an approval review on the Shared link, the user that sent out the link may receive an e-mail to be notified about this.
To modify the content of the notification e-mails, add the following options to the language file and set the desired content in the web bundle:
email.Approval.email_subject=Elvis: {0} - approval complete
email.Approval.email_body=The recipient of your shared link has finished approving or rejecting files:\n\n{0}\n\nView shared link: {1}
email.Import.email_subject=Elvis: {0} - {1} files uploaded
email.Import.email_body={0} files were uploaded to the following shared link:\n\n{1}\n\nView shared link: {2}
Display method of metadata values
Values are typically displayed differently in different languages.
To modify the formatting of numbers as displayed in the metadata, add the following options to the language file and set the desired display method in the cmn bundle:
decimalFormatter.decimalSeparator=,
decimalFormatter.useThousandsSeparator=false
decimalFormatter.thousandsSeparator=.
Display method of dates and times
Dates and times are typically displayed differently in different languages.
To modify the formatting of dates and times as displayed in the metadata, add the following options to the language file and set the desired formatting in the cmn bundle:
dateFormatter.formatString=EEE D MMMM YYYY
datetimeFormatter.formatString=EEE D MMMM YYYY J\:NN\:SS
timeFormatter.formatString=J\:NN\:SS
You compose a pattern string using specific uppercase letters, for example: YYYY/MM. The pattern can contain other text in addition to pattern letters. The following table from Adobe's documentation shows the different possibilities.
| Pattern letter | Description |
|---|---|
| Y |
Year. If the number of pattern letters is two, the year is truncated to two digits; otherwise, it appears as four digits. The year can be zero-padded, as the third example shows in the following set of examples:
|
| M |
Month in year. The format depends on the following criteria:
Examples:
|
| D |
Day in month. While a single-letter pattern string for day is valid, you typically use a two-letter pattern string. Examples:
|
| E |
Day in week. The format depends on the following criteria: If the number of pattern letters is one, the format is interpreted as numeric in one or two digits. If the number of pattern letters is two, the format is interpreted as numeric in two digits. If the number of pattern letters is three, the format is interpreted as short text. If the number of pattern letters is four, the format is interpreted as full text. Examples:
|
| A | am/pm indicator. |
| J | Hour in day (0-23). |
| H | Hour in day (1-24). |
| K | Hour in am/pm (0-11). |
| L | Hour in am/pm (1-12). |
| N |
Minute in hour. Examples:
|
| S |
Second in minute. Example:
|
| Q |
Millisecond in seconds Example: QQ = 78 QQQ = 078 |
| Other text |
You can add other text into the pattern string to further format the string. You can use punctuation, numbers, and all lowercase letters. You should avoid uppercase letters because they may be interpreted as pattern letters. Example:
|
Document history
- 23 November 2018: Updated section 'Custom e-mail messages for shared files' by making it clearer in which bundle the change should be made.
- 23 November 2018: Updated section 'Custom e-mail messages for shared files' by adding information about modifying notification e-mails that are received when users upload files or apply an approval review on a Shared Link.
- 23 November 2018: Updated section 'Display method of metadata values' by making it clearer in which bundle the change should be made.
- 23 November 2018: Updated section 'Display method of dates and times' by making it clearer in which bundle the change should be made.
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
0 comments
Please sign in to leave a comment.