diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 85c6824ab4..32f9f4b4d5 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -26,7 +26,7 @@ Changelog * Site settings are now identifiable/cachable by request as well as site (Andy Babic) * Added `select_related` attribute to site settings to enable more efficient fetching of foreign key values (Andy Babic) * Add caching of image renditions (Tom Dyson, Tim Kamanin) - * Add documentation for reporting security issues (Matt Westcott) + * Add documentation for reporting security issues and internationalisation (Matt Westcott) * Fields on a custom image model can now be defined as required `blank=False` (Matt Westcott) * Fix: Added ARIA alert role to live search forms in the admin (Casper Timmers) * Fix: Reorder login form elements to match expected tab order (Kjartan Sverrisson) diff --git a/docs/advanced_topics/i18n.rst b/docs/advanced_topics/i18n.rst new file mode 100644 index 0000000000..50bcb9834e --- /dev/null +++ b/docs/advanced_topics/i18n.rst @@ -0,0 +1,49 @@ +==================== +Internationalisation +==================== + +Multi-language content +====================== + +In its basic configuration, Wagtail does not provide specific support for multi-language content. This is because there is no single preferred approach to handling translations that works for all scenarios - various approaches are possible, depending on factors such as: + +* The number of languages you intend to support +* Whether the available site content can differ from one language to another, or is the same for all languages +* Whether the type of content you're working with is most naturally modelled as one language per item (e.g. a blog post), or multiple languages per item (e.g. descriptions of a product in a web store) + +Several add-on packages for Wagtail providing multi-language support are available: + +* `Wagtailtrans `_ +* `wagtail-modeltranslation `_ + +For a comparison of these options, see AccordBox's blog post `How to support multi-language in Wagtail CMS `_. + + +Wagtail admin translations +========================== + +The Wagtail admin backend has been translated into many different languages. You can find a list of currently available translations on Wagtail's `Transifex page `_. (Note: if you're using an old version of Wagtail, this page may not accurately reflect what languages you have available). + +If your language isn't listed on that page, you can easily contribute new languages or correct mistakes. Sign up and submit changes to `Transifex `_. Translation updates are typically merged into an official release within one month of being submitted. + +Change Wagtail admin language on a per user basis +================================================= + +Logged-in users can set their preferred language from ``/admin/account/``. +By default, Wagtail provides a list of languages that have a >= 90% translation coverage. +It is possible to override this list via the :ref:`WAGTAILADMIN_PERMITTED_LANGUAGES ` setting. + +In case there is zero or one language permitted, the form will be hidden. + +If there is no language selected by the user, the ``LANGUAGE_CODE`` wil be used. + + +Changing the primary language of your Wagtail installation +========================================================== + +The default language of Wagtail is ``en-us`` (American English). You can change this by tweaking a couple of Django settings: + + - Make sure `USE_I18N `_ is set to ``True`` + - Set `LANGUAGE_CODE `_ to your websites' primary language + +If there is a translation available for your language, the Wagtail admin backend should now be in the language you've chosen. \ No newline at end of file diff --git a/docs/advanced_topics/index.rst b/docs/advanced_topics/index.rst index 76e8366823..c2654d84eb 100644 --- a/docs/advanced_topics/index.rst +++ b/docs/advanced_topics/index.rst @@ -11,6 +11,7 @@ Advanced topics add_to_django_project deploying performance + i18n privacy customisation/index third_party_tutorials diff --git a/docs/releases/2.9.rst b/docs/releases/2.9.rst index c4406d9754..d402b1642b 100644 --- a/docs/releases/2.9.rst +++ b/docs/releases/2.9.rst @@ -39,7 +39,7 @@ Other features * Site settings are now identifiable/cachable by request as well as site (Andy Babic) * Added ``select_related`` attribute to site settings to enable more efficient fetching of foreign key values (Andy Babic) * Add caching of image renditions (Tom Dyson, Tim Kamanin) - * Add documentation for reporting security issues (Matt Westcott) + * Add documentation for reporting security issues and internationalisation (Matt Westcott) * Fields on a custom image model can now be defined as required ``blank=False`` (Matt Westcott)