Cldr.PersonName.Formatter (Cldr Person Names v1.0.0)

View Source

Implements the person name formatting specification.

Summary

Types

Valid :formality option

Valid :format option

Valid options for Cldr.PersonName.to_string/2

Cldr.PersonName.to_string/2 options list

Valid :name_order option

Valid :usage option

Types

formality()

@type formality() :: :informal | :formal

Valid :formality option

format()

@type format() :: :long | :medium | :short

Valid :format option

format_option()

@type format_option() ::
  {:format, format()}
  | {:backend, module()}
  | {:name_order, name_order()}
  | {:usage, usage()}
  | {:formality, formality()}
  | {:locale, Cldr.Locale.locale_reference()}

Valid options for Cldr.PersonName.to_string/2

format_options()

@type format_options() :: [format_option()]

Cldr.PersonName.to_string/2 options list

name_order()

@type name_order() :: :sorting | :surname_first | :given_first

Valid :name_order option

usage()

@type usage() :: :monogram | :referring | :addressing

Valid :usage option

Functions

derive_formatting_locale(name, formatting_locale, name_locale)