Difference between revisions of "Internationalization"
m (adding server i18n page link)
m (→Messages and Text on Web pages)
|Line 141:||Line 141:|
The new generation server is currently translated in transifex here https://www.transifex.net/projects/p/musicbrainz/
The new generation server is currently translated in transifex here https://www.transifex.net/projects/p/musicbrainz/
don't hesitate to subscribe to the team in the language you speak and help translating the web server messages.
don't hesitate to subscribe to the team in the language you speak and help translating the web server messages.
Also, see the [[Server Internationalisation|
Also, see the [[Server Internationalisation|]] for information
Revision as of 18:09, 3 May 2011
- 1 Internationalization (i18n) and Multiple Language Support
- 1.1 Overview
- 1.2 Database
- 1.3 Web Server
- 1.3.1 Messages and Text on Web pages
- 1.3.2 FreeDB importing
- 1.3.3 Browse Artists
- 1.3.4 Quick Searches
- 1.3.5 Advanced Search
- 1.3.6 LuceneSearch
- 1.3.7 Automatic Transliteration
- 1.3.8 Non-linguistic Locale issues
- 1.3.9 Language-specific issues
- 1.4 Wiki
- 1.5 Tagger
- 1.6 Discussion
Internationalization (i18n) and Multiple Language Support
One of the goals of MusicBrainz is to store information about music from all over the world, and since that music is written in many languages, support for those languages is essential. In the future, we also want people to be able to use MusicBrainz in any language, not just English, especially since the people who know the most about music in other languages are often native speakers of those languages.
The decision to use Unicode for MusicBrainz was an important first step on the road to internationalization, and it has allowed entry of hundreds of International Artists with works in dozens of languages, but there remains much work to be done. The work of adapting software so that it can be used with different languages or in different regions is called internationalization (abbreviated as I18N), and translating it into each of those languages and regions is called localization (abbreviated as L10N). Both of these are substantial efforts, but the resources needed are different. Internationalization requires specialized understanding of aspects of many languages, but that is often easier to find than the native linguistic ability in non-Western languages needed for localization.
The following is a breakdown of the many issues for i18n and l10n by area. Issues that should have RFEs filed are marked with RFE ME and a note on the priority (low, med, high). Where RFEs have already been filed, they should be linked.
Many of the most crucial issues for i18n are with the database schema, in order to support the additional data needed to properly localize artists, releases, etc. The localization itself is done by moderators, and can even be done to some extent without full i18n support in the database.
Releases currently record a country with a two-character country code from a fixed set of country codes (that is out of date, missing some countries, and doesn't support four-character historical country codes like SUHH for the Soviet Union, see Bug 971298). There is an up-to-date table of country codes in the Wiki.
Some extra "countries" have been requested, notably for "Benelux", the European Union, "Unknown" and "Worldwide" releases RFE 987023.
Release dates are displayed in the compact artist view, but not in the full/expanded view; the release countries are only displayed in an individual release view. RFE 888401 suggests adding release countries to the compact artist view, and this would be very helpful for those artists who have distinct releases (often bonus tracks) in different countries.
RFE 963571 suggests using flags for displaying them.
Just as releases have countries associated with them, artists, aliases, and releases should have locales associated with them; this would be a way of capturing the language (and country & encoding variants) of the names and titles. The Open I18N guidelines for locale names should be used where possible: the basic format for standard locales is lc
'''.''' CSet, where lc is an ISO 639 two letter LanguageCode (three-letter codes may be used if no two-letter code exists), CC is an ISO 3166 two letter CountryCode, and CSet is an IANA registered preferred MIME encoding name, or if none is preferred, a standard name from Open I18N Codeset Alias Table.
Alternately, we could use the convention adopted for CSS (and other XML/HTML/HTTP?) of using hyphen ("-") as the separator for all components, instead of underscore ("_") and period ("."). The disadvantage of that form is that it doesn't allow you to omit leading components. Extending the Open I18N guidelines, both by allowing any of language/country/encoding to be omitted (if either of the second two components is omitted, their preceding separator would also be omitted) and perhaps to add another variant component, as noted below, adds some functionality that may be very useful.
In most cases, the language code alone would be used, but there would be uses for country variants, e.g. for the group known ("en" as "Yazoo" but in the U.S. "en_US" as "Yaz"). Although it is not strictly speaking correct, simplified Chinese is often identified as "zh_CN" and traditional Chinese as "zh_TW" (although both are used outside of those regions); see [http:#zh below] for a discussion on Chinese languages and scripts.
It may be that the best solution is to add more components for scripts and "dialects" (preceded by hyphen "-") so that you could have "zh-hant-guoyu_CN.UTF-8" to indicate a title in Mandarin (guoyu) using traditional (hant) Chinese characters, in the PRC, using UTF-8 encoding. But this could be overkill. On the other hand there are many languages which use multiple scripts (typically Latin "Latn", Cyrillic "Cyrl" or Arabic "Arab" - see the IANA language tags for examples like Azerbaijani; there are others, like Moldovan, and many cases where very similar dialects (e.g. Hindi-Urdu, Serbo-Croatian) are divided mostly by use of different scripts.
Encoding components could be used to identify misencoded alias names, e.g. "zh.BIG5" for a alias with Big5-misencoded Chinese; and could even be used to automatically generate misencoding aliases for artist names in common character encodings.
It might be desirable to have a fourth variant component (preceded by ":" or another character?) that could be used to identify multiple variants; it could be used to represent misspellings (e.g. "en:TYPO") or performance variants, for association with particular releases (e.g. a release could be marked "en:2" to get the second variant of the artist name, marked with the same locale). There's a discussion of why this might be desirable on the MailingList.
Some possible examples for usage:
- ".UTF-8" (standard alias for any UTF-8 locale in absence of a more specific match; the preferred Artist Name might have this locale implicitly)
- ".ISO-8859-1" (Latin-1 representation)
- ".ASCII" (an ASCII representation without accents etc.)
- "en" (English name, typically for a non-English artist)
- "en_US" (Preferred name in USA, e.g. "Yaz")
Users could specify in preferences their preferred locale; it might also be possible to glean something from X-Accept-Languages: and similar headers in HTTP requests.
One of the most pressing needs is for i18n of artist names. Although all transliterations and translations can be supported by aliases, currently, only the "official" name is used for tagging (ArtistSortNames are displayed but not yet tagged). Especially since tagging of non-latin names is poorly supported, the existing localization of artist names to Japanese and Chinese (or even Cyrillic) creates problems for other users, especially with VariousArtists release where one or two artists with non-latin names appear together with mostly western artists.
A default locale for releases by the artist (and locale indicator for the official ArtistName) should be added. RFE ME med
Since an artist can have an unlimited number of artist aliases, there is some support for i18n already; the MisencodingFAQ has served as a training manual for a number of moderators who have done an excellent job of adding aliases in different languages. RFE 1059830 high suggests adding locales to each alias to indicate their language.
Currently, the database only supports a single sortname for each artist. In order to provide a consistent sort order across multiple alphabets, the generally accepted guideline is to use only roman (latin) alphabet characters in ArtistSortNames. While this is less than ideal, solving this problem internationally is an extremely complex problem, since the rules for sorting vary by locale, and conventions about spelling out numbers in names differ as well. Given the total amount of i18n and l10n work needed for more important problems, and the difficulty of solving this relatively unimportant one, it is probably best to postpone a better solution for this until after the i18n effort is largely complete. In the meantime, some of the following points should probably be added to the style guidelines:
- ArtistSortNames should be restricted to the Latin-1 (8859-1) character set (current convention allows any roman characters, even Vietnamese)
- Sortnames should indicate family name in Asian languages with comma, even though reversal is unneeded, e.g.
- Sortnames should be transliterations of the official artist name, not translations (currently, translations are sometimes used)
- Transliterations should use the artist's home country's standard transliteration into roman characters supported by 8859-1
- If there is no standard transliteration, the standard English transliteration should be used - transliterations into other languages may be different (e.g. Ч = Ch in English, but Ч = Tch in french)
- However, common English spellings should be preferred, e.g. Tchaikovsky, not Chajkovskij.
Points 1 and 3 represent a change from existing convention - comments are welcome on the mailing list. In particular, point 3 is often broken for Asian artists who have "English names" that are not transliterations, but more like alternate names.
For a more international sort, there could be a point requiring numbers to be written numerically (e.g.
4 Tops, The rather than
Four Tops, The ) but as most languages specify sorting numbers as if written out in full (in the local language, of course) this is likely to meet weak acceptance and strong opposition.
Releases and Tracks
Having multiple aliases for each track title seems a far too complex mechanism to ever be implemented; instead it will probably be preferable to have translations on a release basis, so that there will be duplicate entries for releases sharing the same track time data and TRMs. (Release data and disc ids may be something we don't want to share; so that the Japanese release (and disc id) is associated with the Japanese translation, but not the English titles -- this is not yet entirely clear.
Especially now that the database supports assigning DiscIDs to multiple releases, it is quite reasonable to have VirtualDuplicateReleases that are not truly duplicates, since they represent different translations/transliterations.
AdvancedRelationships could potentially be used to link different releases that represent translations/transliterations of each other. TarragonAllen's ReleaseGroups proposal could provide a framework for this as well.
It may be desirable to have per-track locale information, but this should probably be used to record the performance language of a particular track, which would not necessarily be the same as the language of the track title (especially on a translated release).
For titles where translations or transliterations are present together with the original title, perhaps there should be a StyleGuideline specifying use of square brackets; however in most cases it will be preferable to have them in separate titles on duplicate releases. Parts of the original title that are written in latin letters, e.g. (remix) should be omitted from the translated version, e.g. "Знаю Я (remix)I Know".
If a title is given only in translation or transliteration, do not use square brackets, e.g. "Yang Ku Tunggu" not "[Yang Ku Tunggu]".
On VariousArtists releases, Artist aliases that are most compatible with the locale of the release itself should be used. Thus, on an "en" compilation where a Chinese artist appears, her "en" alias (if any) would be preferred to her official "zh" name. There would probably need to be some interaction with user preferences here as well.
As there are sometimes multiple ways to represent the same symbols with different unicode byte sequences (e.g. using combining accent marks) it may be desirable to enter these as aliases; a normalized form should be used for all names and titles in the database. See http://lists.w3.org/Archives/Public/www-xml-canonicalization-comments/2000Jan/0002.html - it's possible that the musicbrainz server and or database software may (or should) do this already.
There's a Perl Unicode normalization tool Charlint that could be used or adapted to do this normalization; for artist names and aliases, which are supposedly unique NFKC (normal form, compatibility decomposition + canonical composition) would probably be best, while for release and track titles, NFC (normal form, canonical decomposition + canonical composition, which doesn't change visible appearance) would probably be better.
There are also ranges of Unicode characters that should be avoided as they do not provide increased range of expression but merely create interoperability issues for those without complete Unicode fonts. In particular, the following should be explicitly prohibited by style guidelines (and perhaps enforced by the database):
- Soft hyphen U+00AD
- Non-breaking space U+00A0
- Byte order mark U+FEFF
- Narrow non-breaking space U+202F
- Ideographic space U+3000
- Medium Mathematical space U+205F
- Typographic spaces U+2000-200B
- Fullwidth latin and halfwidth kana/hangul U+FF00-FFEF
- Roman numeral characters, e.g. single character IX U+2160-217F
- Private use surrogates and codes U+DB80-DBFF U+E000-F8FF
- Control characters U+0000-001F U+007F U+0080-009F
The first two are not specifically Unicode issues, as they occur in Latin-1, but are among the ones where database enforcement is most desirable, as they can lead to artist names that are visually identical in appearance, but which are in fact different. RFE ME low
Chinese scripts and languages
There may be some mapping from simplified to traditional Chinese and vice-versa that could be automatically applied. At least, when searching for simplified or traditional Chinese characters with Google, both traditional and simplified versions are considered to match; there may be more information on this in the Wikipedia multi-lingual coordination project. It would be nice to have some sort of automatic conversion between these, at least for searching. RFE ME low
There are also issues with the locale names. As noted above, zh_CN is often used to indicate Simplified Chinese. and zh_TW to indicate Traditional Chinese, since those are the official scripts of the PRC and Taiwan, respectively. However, both scripts are used elsewhere as well, so this is a bit of a hack. Furthermore, Chinese (although written in only two ways) actually is several distinct languages (Mandarin is the standard, but there are also Cantonese, Hakka, Xiang, and others). As long as we are only concerned with titles, we mostly only need to worry about simplified/traditional, but if we use locales to indicate performance languages like Cantonese, it gets messy (there is some usage of zh_HK to indicate Cantonese, but what about Hakka? etc.) Even without considering performance language, transliterated titles may need better indicators of language. A locale of zh.ASCII would imply Pinyin transliteration (based on Mandarin pronounciation) by default, but if the language was actually Cantonese or Hakka, you end up with zh_HK.ASCII or what?
Bokmål vs. Nynorsk
There was quite recently a prolonged debate on the Wikipedia mailing list about whether the
no (Norwegian) code should be a de facto code for Bokmål, the majority dialect of Norwegian, or if Bokmål should be forced to use its own (less-frequently used) code
nb . (Nynorsk has the code
nn and generally is tagged as such, although it also often uses
no ). It would be nice to avoid a replay of the Wikipedia debates by smart choices up front about these codes. Perhaps mo, as our Norwegian MusicBrain, can provide suggestions.
Although Icelandic uses only characters from the Latin-1 alphabet, there are some unusual locale issues for Icelandic artists. As last names in Icelandic are patronymics rather than family names, and as such are less significant, the phone book is sorted by first names. It would probably be a good idea to have a StyleGuideline that specifies that the ArtistSortName for IcelandicArtists should not be reversed. (Fortunately, this isn't an issue for the most famous Icelandic artist, Björk, as she only uses one name artistically.)
Messages and Text on Web pages
All text and messages in the user interface of the web site are currently in English, and lacks internationalization. But even with internationalization, which is technically fairly straightforward, there are much larger problems with localization: How can you avoid making the process to create new pages awkward and painful? How do you handle translation issues when some of the volunteer translators for a language are slacking and you are ready to roll out a new version of the website? There are several social and technical issues to address here.
We may want to provide something like a wiki interface to allow moderators to "Edit the translation of this page" to update and edit the translated content of the pages; this will make providing new translations as easy as reasonably possible. It doesn't address certain aspects of the user interface that aren't embodied in a web page, e.g. the email sent with moderation notes.
The new generation server is currently translated in transifex here https://www.transifex.net/projects/p/musicbrainz/ don't hesitate to subscribe to the team in the language you speak and help translating the web server messages.
Also, see the NGS Server Internationalisation for language-specific translation guidelines and additional information.
Now that it is possible to select different encodings for the FreeDB data, this is less of a problem; however, there are "breakaway" FreeDB registries apart from FreeDB.org, especially for non-western artists (there is at least one in Japan, and I would not be surprised to find one for India). There should be some way to support importing from alternate FreeDB servers. RFC ME med
Currently, BrowseArtists uses a Latin alphabet with no accents or non-English letters (accents and ligatures/digraphs like ae are mapped to unaccented letters); since ArtistSortNames are restricted to Latin-1 by convention (or future StyleGuideline) as noted [http:#sortname above], this is not a terribly limiting factor. A helpful short-term fix would be to display the regular artist name together with the sortname if they differ. RFE ME low
A complete fix should allow artists to have multiple locale-dependent sortnames, and permit users to choose the desired alphabet to browse in a drop-down or some such. However, given the general uselessness of alphabet-based browsing with a database containing over 100 thousand artists, this is unlikely to ever be worth implementing. Significant improvements to browsing would only come as part of a complete overhaul, probably using genre information that is also not currently stored in the database.
The existing ArtistSearch, ReleaseSearch, and TrackSearch are all based on keyword indexes that use non-alphanumeric characters to break names and titles into words. This works well for simple phonetic scripts, but does poorly with ideographic scripts that don't generally use whitespace and punctuation to separate words. An improvement would be to treat all ideographic characters (Japanese kanji; most, but not all, Chinese characters; Korean hanja and maybe hangul, possibly others) as standalone words. RFE ME med
Currently, AdvancedSearch uses aliases to generate a candidate set of artists that match (based on a quick search) but the relevance ranking is based only on the ArtistName; this gives suboptimal results when a different character set is used, e.g. Advanced Search for artist name Wong.
It should be possible to use locale data to distinguish between correct names and misspelled names added as aliases for search purposes. A better search, like that provided by Lucene, would not rely on aliases entered with typos, but rather use a phonetic similarity algorithm of some sort, so it should ignore misspellings.
There are probably other issues for internationalization of Lucene searching; this area requires more exploration.
Automatic transliteration could be done for many languages if no transliterated/translated alias is available. For best results it is necessary to know the language (e.g. cyrillic script is used by several languages; transliteration will be subtly different from Ukrainian or from Azerbaijani - in the case of Chinese, differences between dialects are even more dramatic). For Japanese, where identical kanji can have multiple different readings, the correct transliteration may not be easy to determine at all. In addition, individual artists often may prefer nonstandard transliteration of their names, or may have an "English" name that isn't really a transliteration.
Non-linguistic Locale issues
There are some issues that are purely based on non-lingustic locale
Different countries use different date formats. While the server uses the international ISO date format (2004-12-08) users may prefer to see other formats (European dd.mm.yyyy or American mm/dd/yyyy). RFE ME low
Most countries use the same minutes:seconds, and since fractional times are only displayed if less than a second, differences in the decimal point (period vs. comma) aren't really an issue. But there many be countries and/or users that prefer minutes.seconds, so it would be nice to internationalize this as well. RFE ME low
Currently the user can select a preference for a single Amazon site; but some releases are available only on one site. RFE 1031066 suggests that some way to have a default (or fallback) store for each country would be useful, and could be used based on release country if no match is found at the user's preferred store.
There are some issues that are particular to specific languages. Since the browser is doing the rendering, problems like combining characters aren't an issue for MusicBrainz, but some issues remain.
Greek final sigma
Right-to-Left Support (Arabic & Hebrew)
Characters in these alphabets are written right-to-left, and the hairy and complex bidirectionality support tries to make these work correctly, even when embedded in a page that is primarily left-to-right. However, some things get botched. Meta-information in parentheses, like (disc 1), is particularly mangled, and in subcription notification emails, you also get things like "2) <hebrew> open, 4 applied)" since parentheses and numbers don't override the current default direction, and parentheses are reversed based on current direction. Judicious use of RTL and LTR overrides at the beginning and end of artist names in Arabic and Hebrew would help (although I don't believe they should be embedded in the artist names themselves). RFE ME med
Furthermore, for localization of the web server itself into Hebrew and Arabic, right justification (or really, mirror display) of all the pages layouts will be needed. The i18n support for this is surely not yet present. RFE ME low
There seem to be some issues with default 8859-1 encoding on the Wiki pages; it would be better if they used UTF-8. A more general problem is the question of providing translations of the Wiki documentation in other languages. Would we want to adopt the en.wiki.musicbrainz.org convention, as Wikipedia has done? Or are there other solutions?
The MusicBrainzTagger does not handle non-latin (8859-1) characters correctly, but it is probably not worth fixing; the new PicardTagger works somewhat better, but it has problems on different platforms.
ID3v2Tags only provide full i18n support in ID3v2.4 (ID3v1 and ID3v2.3 only support 8859-1 encoding in tags). However, the tagger needs to correctly set the encoding to UTF-8. RFE ME high
Some users may prefer to use other encodings for their tags (e.g. Big5 or other 8859 variants); the tagger should support user selection of preferred encodings. RFE ME med
Support for non-latin filenames in filesystems are patchy and inconsistent; most systems will support any 8859 variant, or UTF-8, but there could be problems with other multibyte encodings. Using the existing UTF-8 encoding should be okay in most cases, but it might be desirable to allow user selection of other encodings. RFE ME low
TarragonAllen set up a mailing list for discussion of internationalization; there is also old InterNationalizationDiscussion taken from the previous version of this wiki page. Further extensive discussion should probably take place there.
For consistency with the WikiName of this page, the U.S. English (en_US) spellings of internationalization and localization have been used throughout, but it is worth noting that British English (en_GB, not en_UK) spells these words with "s" instead of "z": internationalisation and localisation.