Cldr v1.5.1 Cldr.LanguageTag View Source
Represents a language tag as defined in rfc5646 with extensions “u” and “t” as defined in BCP 47.
Language tags are used to help identify languages, whether spoken, written, signed, or otherwise signaled, for the purpose of communication. This includes constructed and artificial languages but excludes languages not intended primarily for human communication, such as programming languages.
Syntax
A language tag is composed from a sequence of one or more “subtags”, each of which refines or narrows the range of language identified by the overall tag. Subtags, in turn, are a sequence of alphanumeric characters (letters and digits), distinguished and separated from other subtags in a tag by a hyphen (“-“, [Unicode] U+002D).
There are different types of subtag, each of which is distinguished by length, position in the tag, and content: each subtag’s type can be recognized solely by these features. This makes it possible to extract and assign some semantic information to the subtags, even if the specific subtag values are not recognized. Thus, a language tag processor need not have a list of valid tags or subtags (that is, a copy of some version of the IANA Language Subtag Registry) in order to perform common searching and matching operations. The only exceptions to this ability to infer meaning from subtag structure are the grandfathered tags listed in the productions ‘regular’ and ‘irregular’ below. These tags were registered under [RFC3066] and are a fixed list that can never change.
The syntax of the language tag in ABNF is:
Language-Tag = langtag ; normal language tags
/ privateuse ; private use tag
/ grandfathered ; grandfathered tags
langtag = language
["-" script]
["-" region]
*("-" variant)
*("-" extension)
["-" privateuse]
language = 2*3ALPHA ; shortest ISO 639 code
["-" extlang] ; sometimes followed by
; extended language subtags
/ 4ALPHA ; or reserved for future use
/ 5*8ALPHA ; or registered language subtag
extlang = 3ALPHA ; selected ISO 639 codes
*2("-" 3ALPHA) ; permanently reserved
script = 4ALPHA ; ISO 15924 code
region = 2ALPHA ; ISO 3166-1 code
/ 3DIGIT ; UN M.49 code
variant = 5*8alphanum ; registered variants
/ (DIGIT 3alphanum)
extension = singleton 1(“-“ (28alphanum))
; Single alphanumerics
; "x" reserved for private use
singleton = DIGIT ; 0 - 9
/ %x41-57 ; A - W
/ %x59-5A ; Y - Z
/ %x61-77 ; a - w
/ %x79-7A ; y - z
privateuse = “x” 1(“-“ (18alphanum))
grandfathered = irregular ; non-redundant tags registered
/ regular ; during the RFC 3066 era
irregular = “en-GB-oed” ; irregular tags do not match
/ "i-ami" ; the 'langtag' production and
/ "i-bnn" ; would not otherwise be
/ "i-default" ; considered 'well-formed'
/ "i-enochian" ; These tags are all valid,
/ "i-hak" ; but most are deprecated
/ "i-klingon" ; in favor of more modern
/ "i-lux" ; subtags or subtag
/ "i-mingo" ; combination
/ "i-navajo"
/ "i-pwn"
/ "i-tao"
/ "i-tay"
/ "i-tsu"
/ "sgn-BE-FR"
/ "sgn-BE-NL"
/ "sgn-CH-DE"
regular = “art-lojban” ; these tags match the ‘langtag’
/ "cel-gaulish" ; production, but their subtags
/ "no-bok" ; are not extended language
/ "no-nyn" ; or variant subtags: their meaning
/ "zh-guoyu" ; is defined by their registration
/ "zh-hakka" ; and all of these are deprecated
/ "zh-min" ; in favor of a more modern
/ "zh-min-nan" ; subtag or sequence of subtags
/ "zh-xiang"
alphanum = (ALPHA / DIGIT) ; letters and numbers
All subtags have a maximum length of eight characters. Whitespace is not permitted in a language tag. There is a subtlety in the ABNF production ‘variant’: a variant starting with a digit has a minimum length of four characters, while those starting with a letter have a minimum length of five characters.
Unicode BCP 47 Extension type “u” - Locale
Extension | Description | Examples |
+———-+ | ———————————————- | ————- |
ca | Calendar type | buddhist, chinese, gregory |
cf | Currency format style | standard, account |
co | Collation type | standard, search, phonetic, pinyin |
cu | Currency type | ISO4217 code like “USD”, “EUR” |
fw | First day of the week identifier | sun, mon, tue, wed, … |
hc | Hour cycle identifier | h12, h23, h11, h24 |
lb | Line break style identifier | strict, normal, loose |
lw | Word break identifier | normal, breakall, keepall |
ms | Measurement system identifier | metric, ussystem, uksystem |
nu | Number system identifier | arabext, armnlow, roman, tamldec |
rg | Region override | The value is a unicode_region_subtag for a regular region (not a macroregion), suffixed by “ZZZZ” |
sd | Subdivision identifier | A unicode_subdivision_id, which is a unicode_region_subtagconcatenated with a unicode_subdivision_suffix. |
ss | Break supressions identifier | none, standard |
tz | Timezone identifier | Short identifiers defined in terms of a TZ time zone database |
va | Common variant type | POSIX style locale variant |
Unicode BCP 47 Extension type “t” - Transforms
Extension | Description |
+———-+ | ————————————————————- |
mo | Transform extension mechanism: to reference an authority or rules for a type of transformation |
s0 | Transform source: for non-languages/scripts, such as fullwidth-halfwidth conversion. |
d0 | Transform sdestination: for non-languages/scripts, such as fullwidth-halfwidth conversion. |
i0 | Input Method Engine transform |
k0 | Keyboard transform |
t0 | Machine Translation: Used to indicate content that has been machine translated |
h0 | Hybrid Locale Identifiers: h0 with the value ‘hybrid’ indicates that the -t- value is a language that is mixed into the main language tag to form a hybrid |
x0 | Private use transform |
Extensions are formatted by specifying keyword pairs after an extension
separator. The example de-DE-u-co-phonebk
specifies German as spoken in
Germany with a collation of phonebk
. Another example, “en-latn-AU-u-cf-account”
represents English as spoken in Australia, with the number system “latn” but
formatting currencies with the “accounting” style.
Link to this section Summary
Functions
Parse a locale name into a Cldr.LangaugeTag
struct
Parse a locale name into a Cldr.LangaugeTag
struct and raises on error
Link to this section Types
t() :: %Cldr.LanguageTag{ canonical_locale_name: String.t(), cldr_locale_name: String.t(), extensions: %{}, gettext_locale_name: term(), language: String.t(), locale: %{}, private_use: [String.t(), ...] | [], rbnf_locale_name: String.t(), requested_locale_name: String.t(), script: String.t() | nil, territory: String.t() | nil, transform: %{}, variant: String.t() | nil }
Link to this section Functions
parse(Locale.local_name()) :: {:ok, LanguageTag.t()} | {:error, {Exception.t(), String.t()}}
parse(Locale.local_name()) :: LanguageTag.t() | none()
Parse a locale name into a Cldr.LangaugeTag
struct.
locale_name
is any valid locale name returned byCldr.known_locale_names/0
Returns:
{:ok, language_tag}
or{:error, reason}
Parse a locale name into a Cldr.LangaugeTag
struct and raises on error
locale_name
is any valid locale name returned byCldr.known_locale_names/0
Returns:
language_tag
orraises and exception