Wiki source code of Internationalization

Last modified by Thomas Mortagne on 2023/10/10

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 XWiki can be set-up to support one or various languages.
7 {{velocity}}
8 #set($locales = $xwiki.getDocument('dev:Community.L10N.SupportedLocales.WebHome').getObjects('dev:Community.L10N.SupportedLocales.Code.LocaleClass'))
9 XWiki has translations in ${locales.size()} languages:
11 {{language showCode="true" codes="#foreach($locale in $locales)#if($locale.locale!='none')#if($foreach.index > 0),#end$locale.locale#end#end"/}}
12 {{/velocity}}
15 If you wish to help out improve translations, check our [[translation platform>>]].
17 = Preferences =
19 Setting up languages is done in the Administration (link on the top left of every page).
21 {{info}}
22 To make use of this feature for Languages with encodings that are not ISO-8859-1, you will need to adjust the encoding for your XWiki setup as documented in the [[Encodings page of the Administrators Guide>>Documentation.AdminGuide.Encoding]].
23 {{/info}}
25 {{image reference="AdminLanguages.png"/}}
27 = Switch to another language =
29 By default the language displayed will be the one coming from the browser. However, on every page you can choose to switch between the different language translations that exist for that page. To do so click on the language name in the top right corner of the screen as shown in the following screenshots. Note that you can also force a language by suffixing a URL with ##language=<2-letter language code>##. In addition you can [[configure your wiki to always use a specific language or force a single language to be used>>Documentation.AdminGuide.Configuration#HLanguagesettings]].
31 {{image reference="LanguageEN.png"/}} <-//English// //Deutsch//-> {{image reference="LanguageDE.png"/}}
33 {{info}}
34 Once you click on a language, you're forcing it and thus all pages which have translations in that language will display these translations by default when you navigate to them.
35 {{/info}}
37 = Page translations =
39 The //title// and //content// of a wiki page can be translated in multiple locales. For this you need to configure your wiki to be multilingual and set the list of supported locales. Once you do this XWiki will try to show you the title and content of the page translation that matches the current user interface locale. If the page has not been translated yet then XWiki will show you the title and content from the original version of the page. You can check the [[Information tab>>Documentation.UserGuide.Features.DocumentLifecycle.WebHome#HInformation]] at the bottom of the page to see the locale of the current page, its original locale, as well as the list of existing and missing page translations. You can use the links to access the available page translations or to create the missing ones.
41 {{version since='13.2RC1,12.10.5'}}
42 You can also use the Translate page button to start creating the missing translation. It opens either the [[in-place editor>>Documentation.UserGuide.Features.PageEditing||anchor="HIn-placeeditingmode"]] or it takes you to the stand-alone editor (Wiki or WYSIWYG) depending on your preferences.
44 {{image reference="translatePageButton.png" /}}
45 {{/version}}
47 = Edit a translation =
49 When editing a plain wiki page the editor will load:
50 * the page translation that corresponds to the current laguage, if it exists and multilingual is on
51 * otherwise, the original page
53 When editing a structured page the editor will load the original page because the structured data (objects) are shared by all page translations.
55 From Wiki and WYSIWYG edit modes, as well as when editing in-place, you can switch to a different page translation or create a missing translation.
57 When editing in-place you get a "Translate" button if the edited page doesn't have a translation for the current locale. Click on the "Translate" button if you wish to create the missing translation, otherwise all the changes you do will be saved to the original version of the page.
59 {{image reference="edit-inplace-new-translation.png"/}}
61 From the Wiki and WYSIWYG edit modes you are able to edit the default (original) page language. The default language is indicated on the right "Document Information" panel as shown below:
63 {{image reference="DefaultLanguageEN.PNG"/}}
65 In the "Document Translations" panel you can see the current language you are performing translations in and the alternative languages you may translate your page to. These are the languages you have previously set up in "Administration".
67 {{image reference="DocumentTranslations.PNG"/}}
69 In order to translate your document in a different language, click on one of the languages (e.g. Fr). As a result you will see the edition mode translated in that language.
71 {{image reference="DefaultLanguageFR.PNG"/}}
73 Once you save a document in one of the languages, that document becomes the original document and the language it is written in becomes the default language.
75 {{image reference="OriginalLanguage.PNG"/}}
77 {{info}}
78 Note that all translations of one page share the same set of XWiki objects. As a result it is impossible to have different objects (and page tags, which are objects too) in different translations for now, but it is planed in next versions.
79 {{/info}}

Get Connected