Unicode::Collate::Locale - Linguistic tailoring for DUCET via Unicode::Collate
use Unicode::Collate::Locale; #construct $Collator = Unicode::Collate::Locale-> new(locale => $locale_name, %tailoring); #sort @sorted = $Collator->sort(@not_sorted); #compare $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.
Note: Strings in @not_sorted, $a and $b are interpreted according to Perl's Unicode support. See perlunicode, perluniintro, perlunitut, perlunifaq, utf8. Otherwise you can use preprocess (cf. Unicode::Collate) or should decode them before.
@not_sorted
$a
$b
preprocess
Unicode::Collate
This module provides linguistic tailoring for it taking advantage of Unicode::Collate.
The new method returns a collator object.
new
A parameter list for the constructor is a hash, which can include a special key 'locale' and its value (case-insensitive) standing for a two-letter language code (ISO-639) like 'en' for English. For example, Unicode::Collate::Locale->new(locale => 'FR') returns a collator tailored for French.
'locale'
'en'
Unicode::Collate::Locale->new(locale => 'FR')
$locale_name may be suffixed with a territory(country) code or a variant code, which are separated with '_'. E.g. en_US for English in USA, es_ES_traditional for Spanish in Spain (Traditional),
$locale_name
'_'
en_US
es_ES_traditional
If $localename is not defined, fallback is selected in the following order:
$localename
1. language_territory_variant 2. language_territory 3. language__variant 4. language 5. default
Tailoring tags provided by Unicode::Collate are allowed as long as they are not used for 'locale' support. Esp. the table tag is always untailorable since it is reserved for DUCET.
table
E.g. a collator for French, which ignores diacritics and case difference (i.e. level 1), with reversed case ordering and no normalization.
Unicode::Collate::Locale->new( level => 1, locale => 'fr', upper_before_lower => 1, normalization => undef )
Unicode::Collate::Locale is a subclass of Unicode::Collate and methods other than new are inherited from Unicode::Collate.
Unicode::Collate::Locale
Here is a list of additional methods:
$Collator->getlocale
Returns a language code accepted and used actually on collation. If linguistic tailoring is not provided for a language code you passed (intensionally for some languages, or due to the incomplete implementation), this method returns a string 'default' meaning no special tailoring.
'default'
locale name description ---------------------------------------------------------- af Afrikaans ar Arabic az Azerbaijani (Azeri) be Belarusian bg Bulgarian ca Catalan cs Czech cy Welsh da Danish de__phonebook German (umlaut as 'ae', 'oe', 'ue') eo Esperanto es Spanish es__traditional Spanish ('ch' and 'll' as a grapheme) et Estonian fi Finnish fil Filipino fo Faroese fr French ha Hausa haw Hawaiian hr Croatian hu Hungarian hy Armenian ig Igbo is Icelandic ja Japanese [1] kk Kazakh kl Kalaallisut lt Lithuanian lv Latvian mk Macedonian mt Maltese nb Norwegian Bokmal nn Norwegian Nynorsk nso Northern Sotho om Oromo pl Polish ro Romanian ru Russian se Northern Sami sk Slovak sl Slovenian sq Albanian sr Serbian sv Swedish sw Swahili tn Tswana to Tonga tr Turkish uk Ukrainian vi Vietnamese wo Wolof yo Yoruba ----------------------------------------------------------
Locales according to the default UCA rules include de (German), en (English), ga (Irish), id (Indonesian), it (Italian), ka (Georgian), ln (Lingala), ms (Malay), nl (Dutch), pt (Portuguese), st (Southern Sotho), xh (Xhosa), zu (Zulu).
Note
[1] ja: Ideographs are sorted in JIS X 0208 order. Fullwidth and halfwidth forms are identical to their normal form. The difference between hiragana and katakana is at the 4th level, the comparison also requires (variable => 'Non-ignorable'), and then katakana_before_hiragana has no effect.
(variable => 'Non-ignorable')
katakana_before_hiragana
Installation of Unicode::Collate::Locale requires Collate/Locale.pm, Collate/Locale/*.pm, Collate/CJK/*.pm and Collate/allkeys.txt. On building, Unicode::Collate::Locale doesn't require any of data/*.txt, gendata/*, and mklocale. Tests for Unicode::Collate::Locale are named t/loc_*.t.
Even if a certain letter is tailored, its equivalent would not always tailored as well as it. For example, even though W is tailored, fullwidth W (U+FF37), W with acute (U+1E82), etc. are not tailored. The result may depend on whether source strings are normalized or not, and whether decomposed or composed. Thus (normalization => undef is less preferred.
U+FF37
U+1E82
(normalization => undef
The Unicode::Collate::Locale module for perl was written by SADAHIRO Tomoyuki, <SADAHIRO@cpan.org>. This module is Copyright(C) 2004-2010, SADAHIRO Tomoyuki. Japan. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
http://www.unicode.org/reports/tr10/
http://www.unicode.org/Public/UCA/latest/allkeys.txt
http://www.unicode.org/reports/tr35/
http://cldr.unicode.org/
To install Unicode::Collate, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Unicode::Collate
CPAN shell
perl -MCPAN -e shell install Unicode::Collate
For more information on module installation, please visit the detailed CPAN module installation guide.