Unicode::Collate::Locale - Linguistic tailoring for DUCET via Unicode::Collate

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Unicode::Collate::Locale - Linguistic tailoring for DUCET via Unicode::Collate - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/Unicode::Collate::Locale"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.38.3</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Unicode::Collate::Locale">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Unicode::Collate::Locale">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Unicode::Collate::Locale">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item active" href="/5.38.3/Unicode::Collate::Locale">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Unicode::Collate::Locale">5.38.2</a> <a class="dropdown-item" href="/5.38.1/Unicode::Collate::Locale">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Unicode::Collate::Locale">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Unicode::Collate::Locale">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Unicode::Collate::Locale">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Unicode::Collate::Locale">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Unicode::Collate::Locale">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Unicode::Collate::Locale">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Unicode::Collate::Locale">5.34.2</a> <a class="dropdown-item" href="/5.34.1/Unicode::Collate::Locale">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Unicode::Collate::Locale">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Unicode::Collate::Locale">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Unicode::Collate::Locale">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Unicode::Collate::Locale">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Unicode::Collate::Locale">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Unicode::Collate::Locale">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Unicode::Collate::Locale">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Unicode::Collate::Locale">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Unicode::Collate::Locale">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Unicode::Collate::Locale">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Unicode::Collate::Locale">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Unicode::Collate::Locale">5.26.3</a> <a class="dropdown-item" href="/5.26.2/Unicode::Collate::Locale">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Unicode::Collate::Locale">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Unicode::Collate::Locale">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/Unicode::Collate::Locale">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Unicode::Collate::Locale">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Unicode::Collate::Locale">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Unicode::Collate::Locale">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Unicode::Collate::Locale">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Unicode::Collate::Locale">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Unicode::Collate::Locale">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Unicode::Collate::Locale">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Unicode::Collate::Locale">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Unicode::Collate::Locale">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Unicode::Collate::Locale">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Unicode::Collate::Locale">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Unicode::Collate::Locale">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Unicode::Collate::Locale">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Unicode::Collate::Locale">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Unicode::Collate::Locale">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Unicode::Collate::Locale">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Unicode::Collate::Locale">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Unicode::Collate::Locale">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Unicode::Collate::Locale">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Unicode::Collate::Locale">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Unicode::Collate::Locale">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Unicode::Collate::Locale">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Unicode::Collate::Locale">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Unicode::Collate::Locale">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Unicode::Collate::Locale">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Unicode::Collate::Locale">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Unicode::Collate::Locale">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Unicode::Collate::Locale">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Unicode::Collate::Locale">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Unicode::Collate::Locale">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Unicode::Collate::Locale">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Unicode::Collate::Locale">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Unicode::Collate::Locale">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Unicode::Collate::Locale">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Unicode::Collate::Locale">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Unicode::Collate::Locale">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Unicode::Collate::Locale">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Unicode::Collate::Locale">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Unicode::Collate::Locale">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Unicode::Collate::Locale">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Unicode::Collate::Locale">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Unicode::Collate::Locale">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Unicode::Collate::Locale">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Unicode::Collate::Locale">5.8.1</a> <a class="dropdown-item" href="/5.8.0/Unicode::Collate::Locale">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Unicode::Collate::Locale">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Unicode::Collate::Locale">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Unicode::Collate::Locale">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Unicode::Collate::Locale">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Unicode::Collate::Locale">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Unicode::Collate::Locale">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Unicode::Collate::Locale">5.005_01</a> <a class="dropdown-item" href="/5.005/Unicode::Collate::Locale">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/Unicode::Collate::Locale">blead</a> <a class="dropdown-item" href="/5.41.10/Unicode::Collate::Locale">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Unicode::Collate::Locale">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Unicode::Collate::Locale">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Unicode::Collate::Locale">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Unicode::Collate::Locale">5.41.6</a> <a class="dropdown-item" href="/5.41.5/Unicode::Collate::Locale">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Unicode::Collate::Locale">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Unicode::Collate::Locale">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Unicode::Collate::Locale">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Unicode::Collate::Locale">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Unicode::Collate::Locale">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Unicode::Collate::Locale">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Unicode::Collate::Locale">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Unicode::Collate::Locale">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Unicode::Collate::Locale">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Unicode::Collate::Locale">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Unicode::Collate::Locale">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Unicode::Collate::Locale">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Unicode::Collate::Locale">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Unicode::Collate::Locale">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Unicode::Collate::Locale">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Unicode::Collate::Locale">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Unicode::Collate::Locale">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Unicode::Collate::Locale">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.38.3/perl">Perl</a> <a class="dropdown-item" href="/5.38.3/perlintro">Intro</a> <a class="dropdown-item" href="/5.38.3/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.38.3/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.38.3/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/perlop">Operators</a> <a class="dropdown-item" href="/5.38.3/functions">Functions</a> <a class="dropdown-item" href="/5.38.3/variables">Variables</a> <a class="dropdown-item" href="/5.38.3/modules">Modules</a> <a class="dropdown-item" href="/5.38.3/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.38.3/perlcommunity">Community</a> <a class="dropdown-item" href="/5.38.3/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.38.3/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.38.3/Unicode::Collate::Locale">Unicode::Collate::Locale</a> <div id="more"> (<a href="/5.38.3/Unicode::Collate::Locale.txt">source</a>, <a href="https://metacpan.org/pod/Unicode::Collate::Locale">CPAN</a>) </div> <div id="moduleversion">version 1.31</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.38.3. <a href="/Unicode::Collate::Locale">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> <ul> <li> <a class="text-decoration-none" href="#Constructor">Constructor</a> </li> <li> <a class="text-decoration-none" href="#Methods">Methods</a> </li> <li> <a class="text-decoration-none" href="#A-list-of-tailorable-locales">A list of tailorable locales</a> </li> <li> <a class="text-decoration-none" href="#A-list-of-variant-codes-and-their-aliases">A list of variant codes and their aliases</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#INSTALL">INSTALL</a> </li> <li> <a class="text-decoration-none" href="#CAVEAT">CAVEAT</a> <ul> <li> <a class="text-decoration-none" href="#Reference">Reference</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Unicode::Collate::Locale - Linguistic tailoring for DUCET via Unicode::Collate</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>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.</code></pre> <p><b>Note:</b> Strings in <code>@not_sorted</code>, <code>$a</code> and <code>$b</code> are interpreted according to Perl's Unicode support. See <a href="/5.38.3/perlunicode">perlunicode</a>, <a href="/5.38.3/perluniintro">perluniintro</a>, <a href="/5.38.3/perlunitut">perlunitut</a>, <a href="/5.38.3/perlunifaq">perlunifaq</a>, <a href="/5.38.3/utf8">utf8</a>. Otherwise you can use <code>preprocess</code> (cf. <code>Unicode::Collate</code>) or should decode them before.</p> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>This module provides linguistic tailoring for it taking advantage of <code>Unicode::Collate</code>.</p> <h2 id="Constructor"><a class="permalink" href="#Constructor">#</a>Constructor</h2> <p>The <code>new</code> method returns a collator object.</p> <p>A parameter list for the constructor is a hash, which can include a special key <code>locale</code> and its value (case-insensitive) standing for a Unicode base language code (two or three-letter). For example, <code>Unicode::Collate::Locale->new(locale => 'ES')</code> returns a collator tailored for Spanish.</p> <p><code>$locale_name</code> may be suffixed with a Unicode script code (four-letter), a Unicode region (territory) code, a Unicode language variant code. These codes are case-insensitive, and separated with <code>'_'</code> or <code>'-'</code>. E.g. <code>en_US</code> for English in USA, <code>az_Cyrl</code> for Azerbaijani in the Cyrillic script, <code>es_ES_traditional</code> for Spanish in Spain (Traditional).</p> <p>If <code>$locale_name</code> is not available, fallback is selected in the following order:</p> <pre><code class="plaintext">1. language with a variant code 2. language with a script code 3. language with a region code 4. language 5. default</code></pre> <p>Tailoring tags provided by <code>Unicode::Collate</code> are allowed as long as they are not used for <code>locale</code> support. Esp. the <code>table</code> tag is always untailorable, since it is reserved for DUCET.</p> <p>However <code>entry</code> is allowed, even if it is used for <code>locale</code> support, to add or override mappings.</p> <p>E.g. a collator for Spanish, which ignores diacritics and case difference (i.e. level 1), with reversed case ordering and no normalization.</p> <pre><code>Unicode::Collate::Locale->new( level => 1, locale => 'es', upper_before_lower => 1, normalization => undef )</code></pre> <p>Overriding a behavior already tailored by <code>locale</code> is disallowed if such a tailoring is passed to <code>new()</code>.</p> <pre><code>Unicode::Collate::Locale->new( locale => 'da', upper_before_lower => 0, # causes error as reserved by 'da' )</code></pre> <p>However <code>change()</code> inherited from <code>Unicode::Collate</code> allows such a tailoring that is reserved by <code>locale</code>. Examples:</p> <pre><code>new(locale => 'fr_ca')->change(backwards => undef) new(locale => 'da')->change(upper_before_lower => 0) new(locale => 'ja')->change(overrideCJK => undef)</code></pre> <h2 id="Methods"><a class="permalink" href="#Methods">#</a>Methods</h2> <p><code>Unicode::Collate::Locale</code> is a subclass of <code>Unicode::Collate</code> and methods other than <code>new</code> are inherited from <code>Unicode::Collate</code>.</p> <p>Here is a list of additional methods:</p> <dl> <dt id="$Collator->getlocale"><a class="permalink" href="#$Collator-%3Egetlocale">#</a><a id="getlocale"></a><a id="Collator-getlocale"></a><code>$Collator->getlocale</code></dt> <dd> <p>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 <code>'default'</code> meaning no special tailoring.</p> </dd> <dt id="$Collator->locale_version"><a class="permalink" href="#$Collator-%3Elocale_version">#</a><a id="locale_version"></a><a id="Collator-locale_version"></a><code>$Collator->locale_version</code></dt> <dd> <p>(Since Unicode::Collate::Locale 0.87) Returns the version number (perhaps <code>/\d\.\d\d/</code>) of the locale, as that of <i>Locale/*.pl</i>.</p> <p><b>Note:</b> <i>Locale/*.pl</i> that a collator uses should be identified by a combination of return values from <code>getlocale</code> and <code>locale_version</code>.</p> </dd> </dl> <h2 id="A-list-of-tailorable-locales"><a class="permalink" href="#A-list-of-tailorable-locales">#</a><a id="A"></a>A list of tailorable locales</h2> <pre><code class="plaintext"> locale name description -------------------------------------------------------------- af Afrikaans ar Arabic as Assamese az Azerbaijani (Azeri) be Belarusian bn Bengali bs Bosnian (tailored as Croatian) bs_Cyrl Bosnian in Cyrillic (tailored as Serbian) ca Catalan cs Czech cu Church Slavic cy Welsh da Danish de__phonebook German (umlaut as 'ae', 'oe', 'ue') de_AT_phonebook Austrian German (umlaut primary greater) dsb Lower Sorbian ee Ewe eo Esperanto es Spanish es__traditional Spanish ('ch' and 'll' as a grapheme) et Estonian fa Persian fi Finnish (v and w are primary equal) fi__phonebook Finnish (v and w as separate characters) fil Filipino fo Faroese fr_CA Canadian French gu Gujarati ha Hausa haw Hawaiian he Hebrew hi Hindi hr Croatian hu Hungarian hy Armenian ig Igbo is Icelandic ja Japanese [1] kk Kazakh kl Kalaallisut kn Kannada ko Korean [2] kok Konkani lkt Lakota ln Lingala lt Lithuanian lv Latvian mk Macedonian ml Malayalam mr Marathi mt Maltese nb Norwegian Bokmal nn Norwegian Nynorsk nso Northern Sotho om Oromo or Oriya pa Punjabi pl Polish ro Romanian sa Sanskrit se Northern Sami si Sinhala si__dictionary Sinhala (U+0DA5 = U+0DA2,0DCA,0DA4) sk Slovak sl Slovenian sq Albanian sr Serbian sr_Latn Serbian in Latin (tailored as Croatian) sv Swedish (v and w are primary equal) sv__reformed Swedish (v and w as separate characters) ta Tamil te Telugu th Thai tn Tswana to Tonga tr Turkish ug_Cyrl Uyghur in Cyrillic uk Ukrainian ur Urdu vi Vietnamese vo Volapu"k wae Walser wo Wolof yo Yoruba zh Chinese zh__big5han Chinese (ideographs: big5 order) zh__gb2312han Chinese (ideographs: GB-2312 order) zh__pinyin Chinese (ideographs: pinyin order) [3] zh__stroke Chinese (ideographs: stroke order) [3] zh__zhuyin Chinese (ideographs: zhuyin order) [3] --------------------------------------------------------------</code></pre> <p>Locales according to the default UCA rules include am (Amharic) without <code>[reorder Ethi]</code>, bg (Bulgarian) without <code>[reorder Cyrl]</code>, chr (Cherokee) without <code>[reorder Cher]</code>, de (German), en (English), fr (French), ga (Irish), id (Indonesian), it (Italian), ka (Georgian) without <code>[reorder Geor]</code>, mn (Mongolian) without <code>[reorder Cyrl Mong]</code>, ms (Malay), nl (Dutch), pt (Portuguese), ru (Russian) without <code>[reorder Cyrl]</code>, sw (Swahili), zu (Zulu).</p> <p><b>Note</b></p> <p>[1] ja: Ideographs are sorted in JIS X 0208 order. Fullwidth and halfwidth forms are identical to their regular form. The difference between hiragana and katakana is at the 4th level, the comparison also requires <code>(variable => 'Non-ignorable')</code>, and then <code>katakana_before_hiragana</code> has no effect.</p> <p>[2] ko: Plenty of ideographs are sorted by their reading. Such an ideograph is primary (level 1) equal to, and secondary (level 2) greater than, the corresponding hangul syllable.</p> <p>[3] zh__pinyin, zh__stroke and zh__zhuyin: implemented alt='short', where a smaller number of ideographs are tailored.</p> <h2 id="A-list-of-variant-codes-and-their-aliases"><a class="permalink" href="#A-list-of-variant-codes-and-their-aliases">#</a><a id="A1"></a>A list of variant codes and their aliases</h2> <pre><code class="plaintext"> variant code alias ------------------------------------------ dictionary dict phonebook phone phonebk reformed reform traditional trad ------------------------------------------ big5han big5 gb2312han gb2312 pinyin stroke zhuyin ------------------------------------------</code></pre> <p>Note: 'pinyin' is Han in Latin, 'zhuyin' is Han in Bopomofo.</p> <h1 id="INSTALL"><a class="permalink" href="#INSTALL">#</a>INSTALL</h1> <p>Installation of <code>Unicode::Collate::Locale</code> requires <i>Collate/Locale.pm</i>, <i>Collate/Locale/*.pm</i>, <i>Collate/CJK/*.pm</i> and <i>Collate/allkeys.txt</i>. On building, <code>Unicode::Collate::Locale</code> doesn't require any of <i>data/*.txt</i>, <i>gendata/*</i>, and <i>mklocale</i>. Tests for <code>Unicode::Collate::Locale</code> are named <i>t/loc_*.t</i>.</p> <h1 id="CAVEAT"><a class="permalink" href="#CAVEAT">#</a>CAVEAT</h1> <dl> <dt id="Tailoring-is-not-maximum"><a class="permalink" href="#Tailoring-is-not-maximum">#</a><a id="Tailoring"></a>Tailoring is not maximum</dt> <dd> <p>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 (<code>U+FF37</code>), W with acute (<code>U+1E82</code>), etc. are not tailored. The result may depend on whether source strings are normalized or not, and whether decomposed or composed. Thus <code>(normalization => undef)</code> is less preferred.</p> </dd> <dt id="Collation-reordering-is-not-supported"><a class="permalink" href="#Collation-reordering-is-not-supported">#</a><a id="Collation"></a>Collation reordering is not supported</dt> <dd> <p>The order of any groups including scripts is not changed.</p> </dd> </dl> <h2 id="Reference"><a class="permalink" href="#Reference">#</a>Reference</h2> <pre><code class="plaintext"> locale based CLDR or other reference -------------------------------------------------------------------- af 30 = 1.8.1 ar 30 = 28 ("compat" wo [reorder Arab]) = 1.9.0 as 30 = 28 (without [reorder Beng..]) = 23 az 30 = 24 ("standard" wo [reorder Latn Cyrl]) be 30 = 28 (without [reorder Cyrl]) bn 30 = 28 ("standard" wo [reorder Beng..]) = 2.0.1 bs 30 = 28 (type="standard": [import hr]) bs_Cyrl 30 = 28 (type="standard": [import sr]) ca 30 = 23 (alt="proposed" type="standard") cs 30 = 1.8.1 (type="standard") cu 34 = 30 (without [reorder Cyrl]) cy 30 = 1.8.1 da 22.1 = 1.8.1 (type="standard") de__phonebook 30 = 2.0 (type="phonebook") de_AT_phonebook 30 = 27 (type="phonebook") dsb 30 = 26 ee 30 = 21 eo 30 = 1.8.1 es 30 = 1.9.0 (type="standard") es__traditional 30 = 1.8.1 (type="traditional") et 30 = 26 fa 22.1 = 1.8.1 fi 22.1 = 1.8.1 (type="standard" alt="proposed") fi__phonebook 22.1 = 1.8.1 (type="phonebook") fil 30 = 1.9.0 (type="standard") = 1.8.1 fo 22.1 = 1.8.1 (alt="proposed" type="standard") fr_CA 30 = 1.9.0 gu 30 = 28 ("standard" wo [reorder Gujr..]) = 1.9.0 ha 30 = 1.9.0 haw 30 = 24 he 30 = 28 (without [reorder Hebr]) = 23 hi 30 = 28 (without [reorder Deva..]) = 1.9.0 hr 30 = 28 ("standard" wo [reorder Latn Cyrl]) = 1.9.0 hu 22.1 = 1.8.1 (alt="proposed" type="standard") hy 30 = 28 (without [reorder Armn]) = 1.8.1 ig 30 = 1.8.1 is 22.1 = 1.8.1 (type="standard") ja 22.1 = 1.8.1 (type="standard") kk 30 = 28 (without [reorder Cyrl]) kl 22.1 = 1.8.1 (type="standard") kn 30 = 28 ("standard" wo [reorder Knda..]) = 1.9.0 ko 22.1 = 1.8.1 (type="standard") kok 30 = 28 (without [reorder Deva..]) = 1.8.1 lkt 30 = 25 ln 30 = 2.0 (type="standard") = 1.8.1 lt 22.1 = 1.9.0 lv 22.1 = 1.9.0 (type="standard") = 1.8.1 mk 30 = 28 (without [reorder Cyrl]) ml 22.1 = 1.9.0 mr 30 = 28 (without [reorder Deva..]) = 1.8.1 mt 22.1 = 1.9.0 nb 22.1 = 2.0 (type="standard") nn 22.1 = 2.0 (type="standard") nso [*] 26 = 1.8.1 om 22.1 = 1.8.1 or 30 = 28 (without [reorder Orya..]) = 1.9.0 pa 22.1 = 1.8.1 pl 30 = 1.8.1 ro 30 = 1.9.0 (type="standard") sa [*] 1.9.1 = 1.8.1 (type="standard" alt="proposed") se 22.1 = 1.8.1 (type="standard") si 30 = 28 ("standard" wo [reorder Sinh..]) = 1.9.0 si__dictionary 30 = 28 ("dictionary" wo [reorder Sinh..]) = 1.9.0 sk 22.1 = 1.9.0 (type="standard") sl 22.1 = 1.8.1 (type="standard" alt="proposed") sq 22.1 = 1.8.1 (alt="proposed" type="standard") sr 30 = 28 (without [reorder Cyrl]) sr_Latn 30 = 28 (type="standard": [import hr]) sv 22.1 = 1.9.0 (type="standard") sv__reformed 22.1 = 1.8.1 (type="reformed") ta 22.1 = 1.9.0 te 30 = 28 (without [reorder Telu..]) = 1.9.0 th 22.1 = 22 tn [*] 26 = 1.8.1 to 22.1 = 22 tr 22.1 = 1.8.1 (type="standard") uk 30 = 28 (without [reorder Cyrl]) ug_Cyrl https://en.wikipedia.org/wiki/Uyghur_Cyrillic_alphabet ur 22.1 = 1.9.0 vi 22.1 = 1.8.1 vo 30 = 25 wae 30 = 2.0 wo [*] 1.9.1 = 1.8.1 yo 30 = 1.8.1 zh 22.1 = 1.8.1 (type="standard") zh__big5han 22.1 = 1.8.1 (type="big5han") zh__gb2312han 22.1 = 1.8.1 (type="gb2312han") zh__pinyin 22.1 = 2.0 (type='pinyin' alt='short') zh__stroke 22.1 = 1.9.1 (type='stroke' alt='short') zh__zhuyin 22.1 = 22 (type='zhuyin' alt='short') --------------------------------------------------------------------</code></pre> <p>[*] http://www.unicode.org/repos/cldr/tags/latest/seed/collation/</p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>The Unicode::Collate::Locale module for perl was written by SADAHIRO Tomoyuki, <SADAHIRO@cpan.org>. This module is Copyright(C) 2004-2020, SADAHIRO Tomoyuki. Japan. All rights reserved.</p> <p>This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <dl> <dt id="Unicode-Collation-Algorithm-UTS-#10"><a class="permalink" href="#Unicode-Collation-Algorithm-UTS-%2310">#</a><a id="Unicode"></a><a id="Unicode-Collation-Algorithm---UTS-10"></a>Unicode Collation Algorithm - UTS #10</dt> <dd> <p><a href="http://www.unicode.org/reports/tr10/">http://www.unicode.org/reports/tr10/</a></p> </dd> <dt id="The-Default-Unicode-Collation-Element-Table-(DUCET)"><a class="permalink" href="#The-Default-Unicode-Collation-Element-Table-(DUCET)">#</a><a id="The"></a><a id="The-Default-Unicode-Collation-Element-Table-DUCET"></a>The Default Unicode Collation Element Table (DUCET)</dt> <dd> <p><a href="http://www.unicode.org/Public/UCA/latest/allkeys.txt">http://www.unicode.org/Public/UCA/latest/allkeys.txt</a></p> </dd> <dt id="Unicode-Locale-Data-Markup-Language-(LDML)-UTS-#35"><a class="permalink" href="#Unicode-Locale-Data-Markup-Language-(LDML)-UTS-%2335">#</a><a id="Unicode1"></a><a id="Unicode-Locale-Data-Markup-Language-LDML---UTS-35"></a>Unicode Locale Data Markup Language (LDML) - UTS #35</dt> <dd> <p><a href="http://www.unicode.org/reports/tr35/">http://www.unicode.org/reports/tr35/</a></p> </dd> <dt id="CLDR-Unicode-Common-Locale-Data-Repository"><a class="permalink" href="#CLDR-Unicode-Common-Locale-Data-Repository">#</a><a id="CLDR"></a><a id="CLDR---Unicode-Common-Locale-Data-Repository"></a>CLDR - Unicode Common Locale Data Repository</dt> <dd> <p><a href="http://cldr.unicode.org/">http://cldr.unicode.org/</a></p> </dd> <dt id="Unicode::Collate"><a class="permalink" href="#Unicode::Collate">#</a><a id="Unicode2"></a><a href="/5.38.3/Unicode::Collate">Unicode::Collate</a></dt> <dd> </dd> <dt id="Unicode::Normalize"><a class="permalink" href="#Unicode::Normalize">#</a><a id="Unicode3"></a><a href="/5.38.3/Unicode::Normalize">Unicode::Normalize</a></dt> <dd> </dd> </dl> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

Unicode::Collate::Locale - Linguistic tailoring for DUCET via Unicode::Collate - Perldoc Browser