Page History

This page describes two different types of language locale in Magnolia and how to configure Magnolia for them. The two locales influence the rendering of content in the AdminCentral and on a published page.

What is locale

Two locales in Magnolia

The question of "two locales" is connected with the types of users who access a Magnolia instance.

An ordinary internet user, new or returning – whom we can call public user , or even an application consuming content as JSON or XML via REST API – all of whom we shall call  visitor for simplicity – will usually only be able to see and interact with the pages content of a published web project or website. The user visitor will be interacting – via the web browser – with a running public instance of Magnolia and will expect that the content of each page on the site will be available in a language he can understand or defines in his request, ideally in his native language. A user who's visitor whose native language is English will prefer browsing the English language version of a website content in English (the screenshots are from the Travel Demo):

On the other hand, a Magnolia an editor/, publisher (user) or even a sysadmin – let's for now use refer to them with the term system AdminCentral user  – working with the author instance of Magnolia may have different locale preferences than the public user. A system visitor. An AdminCentral user's native and hence preferred language may be, for example, Spanish but the content being edited may still be in the English language. The system AdminCentral user would probably welcome if the following items in the author instance (see also Types of translatable text) are displayed in Spanish rather than in English:

• Field labels and descriptions,
• Messages (alerts, warnings, information),
• App UI elements such as workbenches, columns, forms and actions, and 
• Buttons in the page editor in edit mode (used to open dialogs)

...

• )

...

Magnolia has been built to deal with these two separate locale preferences, that is with : 

• Public Site Locale
• AdminCentral Locale.

Determining and setting the latter is fairly straightforward since the system users will usually know which locale they prefer. They can also set the locale themselves directly in the AdminCentral or they may always ask a user with superuser rights to set the preferred locale for them.

To determine site public locale is slightly more difficult. Public users Visitors usually access web pages content as anonymous users. Magnolia then has to rely on indirect means that point to the preferred locale of a public user.

...

visitor.

AdminCentral locale

The AdminCentral locale primarily defines the language of User interface labels that the system  which the AdminCentral user wants to work interact in with in the AdminCentral. This concerns, for example, the language of labels in the Action bar (English on the left, Korean on the right):

...

An incomplete localisation of a UI element may result in displaying a label in the fallback language, as shown below in the case the Copy page and Paste page actions:

Image RemovedImage Added

...

Setting and configuring the AdminCentral locale

When logged-in in the AdminCentral, its users may set their language locale parameter via the Language field in the Edit user profile dialog. The setting will be reflected in the names of action menus, actions, buttons and labels throughout the AdminCentral provided the locale is one of the available the available system languages or languages or it will fallback to English, the default fallback language (see also the configuration of available system languages and fallback language but configurableconfiguration). 

To set itthe locale of the AdminCentral, open the pull down menu in the top right corner of the browser window and click the first row of the menu, titled Edit user profile if the current locale setting is English. On the Preferences tab:

• Choose a language in the Language field:
  
  With the superuser role you may can set language locales for other users, see Setting an editor's language preference.

The new locale will be is applied the next time you log in into to the AdminCentral.

...

Public locale

The setting of a site Public locale influences the editorial content and template labels and unless a public user  rendered on a visitor's device. Unless a visitor registers to a web product /or service and actively provides the preferred locale information to the webapp, the webserver public instance has to rely on other means that could help identify the visitors visitor's preferred locale.

Determining the preferred

...

public locale

There are a number of ways of obtaining some form of locale information. Some of them use advanced techniques such as geolocation based on ping delay or topology, but one of the most common way ways is to look into the content of a an HTTP request. At least the following three parts of an HTTP request are relevant to the identification of the public user's locale:

• the User-Agent header
• the Accept-Language header

• Request-URI

From the User-Agent header

While occassionally containing The header may contain information such as en_US , for example in : 

Mozilla/5.0 (compatible; Konqueror/4.5; NetBSD 5.0.2; X11; amd64; en_US) KHTML/4.5.4 (like Gecko)

However, this locale information in the User-Agent header:

• identifies Identifies the language variant of the software sending the request rather than the software's user's preferred locale, .
• is Is usually redundant,.

• and more Is often than not is missing:

  Code Block
  Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36

Magnolia has no direct ready-made means how to check for the existence of and retrieve this type of locale information. The preferred locale information is communicated via the Accept-Language header.

From the Accept-Language header

The Accept-Language request header of an HTTP request defines which language variant of the page is preferred by the public user. This locale information may take one of the following three forms:

...

The first represents language expressed as a 2 or 3-character string, the second represents language as a full language tag, the third says means "any language" (see Accept-Language and Language Tags in RFC-2616).

In addition, each language-range Additionally, the locale value that is sent in the header – optionally in a semicolon-delimited range for more languages – may be given an associated quality value ( q=<qvalue>) which . The quality value represents an estimate of the user's preference for the languages specified by that range, for example:

Accept-Language: cs-CZ,cs;q=0.9,en-US;q=0.8,en;q=0.7

A site in Magnolia may be configured to look set the site's locale according to the In Magnolia the locale information provided in this header, see the configuration section belowthe Accept-Language header can be handled by the RequestLocaleAwareI18nContentSupport implementation of the I18nContentSupport interface, see below in The I18nContentSupport interface subsection.

From Request-URI

The most common form of Request-URI is that used to identify a resource on an origin server or gateway. For example:

https://demopublic.magnolia-cms.com/tour-type~active~.html

The preferred locale information may be sent to the server as a part of a  Request-URI . See below in the configuration section how to configure a site in Magnolia to parse Request-URI for locale information, such as de in the middle following example:

https://demopublic.magnolia-cms.com/de/tour-type~active~.html

...

, such as de in the following example:

/de/tour-type~active~.html

In Magnolia the locale information provided in the Request-URI can be handled by DefaultI18nContentSupport and HierarchyBasedI18nContentSupport implementations of the I18nContentSupport interface, see the details in the following subsection.

The I18nContentSupport interface

When determining the preferred public locale, a key role in deciding which approach to apply is played by the 

• Javadoc resource link
  className info.magnolia.cms.i18n.AbstractI18nContentSupport renderType asynchronous

   – an abstract implementation. The detection of the current locale is left to one of the following three classes.

• Javadoc resource link
  className info.magnolia.cms.i18n.RequestLocaleAwareI18nContentSupport renderType asynchronous

   – relevant to the From the Accept-Language header case described above, this implementation reads the locale from the Accept-Language header. This implementation does not render language specific URIs (see the classes below).

• Javadoc resource link
  className info.magnolia.cms.i18n.DefaultI18nContentSupport renderType asynchronous

   – relevant to the From Request-URI case described above and used in the Magnolia Travel Demo, this implementation supports a language prefix in the URI, such as de for example. It checks if a node data with the <name>_<locale> pattern exists on a content node:
  Image Added
  
  

• Javadoc resource link
  className info.magnolia.cms.i18n.HierarchyBasedI18nContentSupport renderType asynchronous

  Same as above but for a hierarchy, for example:

  Code Block
  my-website ├─en │ ├─page-1 │ └─page-n ├─de │ ├─page-1 │ └─page-n └─de_CH ├─page-1 └─page-n

  The locale code can be at whatever position in the URI, not necessarily the first one. For example, /my-website/node-1/node-2/de/home-page.html .

Configuring locale for a site

The configuration that defines the locale information for a site is usually located:

• In the Enterprise Edition under
  /modules/multisite/config/sites/<site-name>/i18n/locales
• In the Community Edition under
  /site/config/site/<site-name>/i18n/locales
  In the CE's Travel Demo bundle the configuration is extended from /modules/travel-demo/config/travel .

For further details about configuring locale for a site, please see Language configuration: 3. Define locales in site.