[DOXIASITETOOLS-271] Overhaul locale support (make Locale#ROOT instead of Locale#ENGLISH default and use full locale)

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.0.0-M4, 2.0.0
• Component/s: Integration Tools, Site renderer
• Assignee: Michael Osipov
• Reporter: Michael Osipov
• Created: 06/Nov/22 10:35
• Updated: 14/Dec/23 16:49
• Resolved: 26/Nov/22 15:38

Description

The current locale setup has its flaws:

• It forces you assume that the default locale is English which leads to problems that site_en.xml is often not found
• Full locale cannot be used to create a localized site: only language is used, no country nor region: region is critical for example for Simplified chinese vs Traditional, see MSITE-904

This overhaul will implement two changes:

1. The default locale will not be English anymore, but rather ROOT as a language-agnostic one.
2. One can provide a full locale and Doxia Sitetools will incrementally reduce the locale from variant down to root to find the most specific site descriptor, e.g., 'de_DE_BY', 'de_DE', 'de', ''. Assuming that the user has requested 'de_DE_BY' as in German in Germany, specifically in Bavaria.

Both approaches apply the logic from ResouceBundle#getBundle().

Issue Links

• fixes: MSITE-626 Iternazionalization element just uses the language part of specified locales
• is depended upon by: MSITE-639 sub-project tries to fetch a site_en.xml even though no locales are configured
• is depended upon by: MSITE-827 Site builds rely on HTTP 404
• is depended upon by: MSITE-904 Unable to generate zh_TW locale of site document
• is depended upon by: MSITE-820 Change localized output from language to full locale, like source
• relates to: MSITE-225 Internationalization does not seem to work with site:run
• links to: GitHub Pull Request #67