Setting up a multilingual user interface
The user interface culture determines the language of the Xperience administration interface, as well as other factors like numeric and date formats.
The default Xperience installation only provides an English version (en-us culture) for the user interface texts. The texts are stored in resx resource files:
- In the CMS\CMSResources folder of the Xperience administration project
- As embedded resources in application assemblies in the live site project
Multilingual website content
If you want to learn more about localization of website content (i.e. pages in the content tree), please refer to the Setting up multilingual websites chapter.
Users with the Global administrator privilege level can manage all cultures in the Localization application on the Cultures tab. To display only UI cultures, choose Yes in the Is UI culture filter and click Search.
When you create a new culture or edit an existing culture, you can define the following properties:
Name displayed for the culture in the administration interface.
The standard identifier of the culture in format: <language code>-<country/region code>
You cannot use neutral culture codes that represent languages in general. Enter the culture code of a specific country/region. For example en-US, not en.
Culture short name
A shortcut for the culture.
If set, the culture alias is used instead of the culture code in URL language prefixes.
Note: The system does not validate the values set for culture aliases. Make sure aliases do not cause URL collisions with existing URL slugs of pages. For example, a collision can occur if you set a culture alias to English, but already have a page with the English URL slug on the first level of the content tree. In the case of collisions, the culture alias takes priority in page routing.
Is UI culture
Indicates if the culture is available as a language option for the administration interface.
Preparing UI cultures
Xperience allows you to manage content in any language, including double-byte (eastern) languages, such as Chinese. All content is stored and published in UNICODE.
To prepare the system to display the administration interface in a different language or at least with different culture settings (e.g. calendar and numeric format):
- Open the Localization application.
- Select the Cultures tab.
- Edit ( ) the culture you want to use for the administration interface.
- Select the Is UI culture check box.
- Click Save.
Users can now select the new culture as their default UI culture in the My profile application using the Preferred user interface culture drop-down list. However, if the system does not have a corresponding language pack installed, the administration interface strings will still be displayed in the default language.
Installing localization packs
You can download localization packs with already translated resource files for certain languages from DevNet.
After downloading a package:
- Open the package and copy the resx files into the appropriate locations:
- Create a CMSResources folder in the root of your live site project.
- Add the main cms resx files into the CMSResources folder of both the administration and live site project.
- If the pack contains resources for the Xperience builder features (Kentico.Builder.resx, etc.):
- Create an App_Data\Global\Resources folder in your live site project.
- Add a sub-folder matching the culture code of the pack's culture, for example he-IL.
- Copy the builder resx files into the new sub-folder.
Restart the application to apply the changes to the user interface:
- Open the System application.
- Click Restart all web farm servers.
Creating custom localization packs
In case no language pack for your desired culture exists, you can translate the localization strings to your desired language manually. See the following sections for details:
Setting the default UI culture for the administration interface
The default UI culture is en-us. If you configure the system to allow multiple UI cultures, you can change the default UI culture for users by adding the following key to the <appSettings> section of the web.config file for BOTH your administration and live site project:
<add key="CMSDefaultUICulture" value="en-nz" />
The default UI culture is en-us. If you configure the system to allow multiple UI cultures, you can change the default UI culture for users by adding the following key to:
The <appSettings> section of the web.config file in your administration project
<add key="CMSDefaultUICulture" value="en-nz" />
Your live site application's configuration file (appsettings.json by default)
The value of this key must be a valid culture code (in the example above, en-nz represents the English - New Zealand culture).
If you change the default UI culture, you also need to rename the CMSResources\CMS.resx file to CMS.en-us.resx and the new culture's resource string file (CMS.en-nz.resx in the example) to CMS.resx.
This is required because the resx files without a culture suffix or sub-folder are used when the (default) option is selected as a user's Preferred user interface culture.
When the above mentioned key is set and the CMS.resx file contains the en-nz dictionary, the UI culture will be en-nz for users who have their Preferred user interface culture set to (default).
Applying a culture to a specific user's UI
You can set the administration interface to a specific culture for each user in the system:
- Open the Users application.
- Edit ( ) the user.
- Select the required Preferred user interface culture on the General tab.
- Click Save.
Users may also select their own user interface culture in the My profile application on the Details tab, by setting the Preferred user interface culture.
When the user signs out and then back in, the system displays the interface according to the new culture settings and with translated strings (once the translation is complete).
Users can also change the culture of their interface by opening the User menu and clicking on Change language. This selection also changes the Preferred user interface culture setting of the given user.