Supported Locales

Last modified by Thomas Mortagne on 2022/05/11 09:46

Here is the current list of supported locales:

New locale checklist

Starting to translate a new locale in XWiki is great but it's only part of the story. To fully support a new locale XWiki sometimes needs to configure a few things.

When a pull request comes with translations for a locale which is not listed above you should make sure the following checklist is complete for all the branches in which the translation will end up before accepting it:

  • Make sure it's using the right format.
  • Make sure there is Java support for this locale.
    • Generic stuff like dates or even the display name of the locale itself are not in any translation file provided by XWiki but instead they are provided by standard Java APIs.
    • It means it needs to be supported by either Java or ICU (which is part of Java 9+).
  • Make sure it's supported in the Solr search core
  • Make sure XWiki embeds fonts for it
    • Used for PDF export for example.
    • The simplest to validate this is generally to copy/paste characters of this locale in a wiki page and see the result of a PDF export.
    • See the currently embedded fonts.
  • Make sure there is corresponding name/flag for it in the Language Macro

Add the new supported locale

Once the new translation has been committed add an xobject with the new locale.

Changelog

Here are listed the versions in which each locales started to be translated in XWiki.

10.3

8.4

7.3

6.0

4.1

3.3

2.3

2.2

2.0

1.9.1

1.9

1.6

1.5.1

1.5

1.4

1.3.1

1.3

1.2

Before 1.1

Unknown

Issues

While some locale where added to XWiki a long time ago, there was often no check on whether or not XWiki really supports it properly so we ended up with "supported" locales which are not fully usable. Following is the list of issue that need to be fixed:

Tags:
   

Get Connected