Unicode Technical Standard #35

Unicode Locale Data Markup Language (LDML)
Part 8: Person Names

For the full header, summary, and status, see Part 1: Core.

Summary

This document describes parts of an XML format (vocabulary) for the exchange of structured locale data. This format is used in the Unicode Common Locale Data Repository.

This is a partial document, describing only those parts of the LDML that are relevant for person names (name structure, formats, sorting). For the other parts of the LDML see the main LDML document and the links above.

Status

This document has been reviewed by Unicode members and other interested parties, and has been approved for publication by the Unicode Consortium. This is a stable document and may be used as reference material or cited as a normative reference by other specifications.

A Unicode Technical Standard (UTS) is an independent specification. Conformance to the Unicode Standard does not imply conformance to any UTS.

Please submit corrigenda and other comments with the CLDR bug reporting form [Bugs]. Related information that is useful in understanding this document is found in the References. For the latest version of the Unicode Standard see [Unicode]. For a list of current Unicode Technical Reports see [Reports]. For more information about versions of the Unicode Standard, see [Versions].

Parts

The LDML specification is divided into the following parts:

• Part 1: Core (languages, locales, basic structure)
• Part 2: General (display names & transforms, etc.)
• Part 3: Numbers (number & currency formatting)
• Part 4: Dates (date, time, time zone formatting)
• Part 5: Collation (sorting, searching, grouping)
• Part 6: Supplemental (supplemental data)
• Part 7: Keyboards (keyboard mappings)
• Part 8: Person Names (person names)

Contents of Part 8, Person Names

• CLDR Person Names
  • Introduction
    • Not in scope
  • API Implementation
  • Person Name Formatting Overview
  • Example Usage
• XML Structure
  • personNames Element
  • personName Element
  • nameOrderLocales Element
  • foreignSpaceReplacement Element
  • initialPattern Element
    • Syntax
• Person Name Object
• Person Name Attributes
  • order
  • length
  • usage
  • formality
• namePattern Syntax
  • Fields
  • Modifiers
• Formatting Process
  • Derive the name locale
  • Derive the formatting locale
    • Switch the formatting locale if necessary
  • Derive the name order
  • Choose a personName element
  • Choose a namePattern
  • Access PersonName object
    • Handle missing surname
    • Handle core and prefix
    • Derive initials
  • Process a namePattern
    • Handling foreign names
    • Setting the spaceReplacement
    • Examples of space replacement
  • Formatting examples
• Sample Name
  • Syntax
  • Expected values
• PersonName Data Interface Examples
  • Example 1
  • Example 2

CLDR Person Names

Introduction

CLDR provides formatting for person names, such as John Smith or 宮崎駿. These use patterns to show how a name object (for example, from a database) should be formatted for a particular locale. Name data has fields for the parts of people’s names, such as a given field with a value of “Maria”, and a surname field value of “Schmidt”.

There is a wide variety in the way that people’s names appear in different languages.

• People may have a different number of names, depending on their culture—they might have only one name (“Zendaya”), two (“Albert Einstein”), or three or more.
• People may have multiple words in a particular name field, eg “Mary Beth” as a given name, or “van Berg” as a surname.
• Some languages, such as Spanish, have two surnames (where each can be composed of multiple words).
• The ordering of name fields can be different across languages, as well as the spacing (or lack thereof) and punctuation.
• Name formatting needs to be adapted to different circumstances, such as a need to be presented shorter or longer; formal or informal context; or when talking about someone, or talking to someone, or as a monogram (JFK).

This document provides the LDML specification for formatting of personal names, using data, structure, and examples.

The CLDR functionality is targeted at formatting names for typical usage on computers (e.g. contact names, automated greetings, etc.), rather than being designed for special circumstances or protocol, such addressing royalty. However, the structure may be enhanced in the future when it becomes clear that additional features are needed for some languages.

This addition to CLDR is based on review of current standards and practices that exist in LDAP, OECD, S42, hCard, HTML and various other international standards and commercial implementations.

Additions to those structures were made to accommodate known issues in large population groups, such as mononyms in Indonesia, patronymic and matronymic naming structure in Iceland and India, the need for a second surname in Spanish-speaking regions and the common case of chains of patronymic names in Arabic-speaking locales. The formatting patterns allow for specifying different “input parameters” to account for different contexts.

Not in scope

The following features are currently out of scope for Person Names formating:

• Grammatical inflection of formatted names.
• Context-specific cultural aspects, such as when to use “-san” vs “-sama” when addressing a Japanese person.
• Providing locale-specific lists of titles, generation terms, and credentials for use in pull-down menus or validation (Mr, Ms., Mx., Dr., Jr., M.D., etc.).
• Validation of input, such as which fields are required, and what characters are allowed.
• Combining alternative names, such as multicultural names in Hong Kong "Jackie Chan Kong-Sang”, or ‘Dwayne “The Rock” Johnson’.
• More than two levels of formality for names.
• Parsing of names:

  • Parsing of name strings into specific name parts such as given and given2. A name like "Mary Beth Estrella" could conceivably be any of the following.

    given	given2	surname	surname2
    Mary	Beth	Estrella
    Mary Beth		Estrella
    Mary		Beth Estrella
    Mary		Beth	Estrella

  • Parsing out the other components of a name in a string, such as surname prefixes (Tussenvoegsel in Dutch).

API Implementation

A draft API for formatting personal names is included in ICU4J 73. (“Draft” means that the full functionality is present, but the API might be refined before it is stabilized.) The implementation can be found at PersonNameFormatter.java and SimplePersonName.java.

Person Name Formatting Overview

Logically, the model used for applying the CLDR data is the following:

Conceptually, CLDR person name formatting depends on data supplied by a PersonName Data Interface. That could be a very thin interface that simply accesses a database record, or it could be a more sophisticated interface that can modify the raw data before presenting it to be formatted. For example, based on the formatting locale a PersonName data interface could transliterate names that are in another script, or supply equivalent titles in different languages.

The specification below will talk about a “PersonName object” as an entity that is logically accessed via such an interface. If multiple formatted names are needed, such as in different scripts or with alternate names, or pronunciations (eg kana), the presumption is that those are logically separate PersonName objects. See [Person Name Object].

The following summarizes the name data supplied via the PersonName Data Interface:

• Name data is composed of one or more name parts, which are categorized in this standard as
  • title - a string that represents one or more honorifics or titles, such as “Mr.”, or “Herr Doctor”.
  • given - usually a name given to someone that is not passed to a person by way of parentage
  • given2 - name or names that may appear between the first given name string and the surname. In the West, this may be a middle name, in Slavic regions it may be a patronymic name, and in parts of the Middle East, it may be the nasab (نسب) or series of patronymics.
  • surname - usually the family name passed to a person that indicates their family, tribe, or community. In most Western languages, this is known as the last name.
  • surname2 - in some cultures, both the parent’s surnames are used and need to be handled separately for formatting in different contexts.
  • generation - a string that represents a generation marker, such as “Jr.” or “III”.
  • credentials - a string that represents one or more credentials or accreditations, such as “M.D.”, or “MBA”.
  • See the section on [Fields] for more details.
• Name data may have additional attributes that this specification accommodates.
  • -informal - A name may have a formal and an informal presentation form, for example “Bob” vs “Robert” or “Са́ша” vs “Алекса́ндра”. This is accomplished by using the simple construct given-informal.
  • -prefix and -core - In some languages the surname may have a prefix that needs to be treated differently, for example “van den Berg”. The data can refer to “van den” as surname-prefix and “Berg” with surname-core and the PersonNames formatters will format them correctly in Dutch and many other languages.
  • See the section on [Modifiers] for more details.

To format a name correctly, the correct context needs to be known. The context is composed of:

• The formatting locale. This is used to choose the primary set of patterns to format name data.
• The name locale. If the name data comes from a locale different from the formatting locale, it may need to be handled differently. If the name locale is not known, an inferred name locale is derived from the information in the name and the formatting locale.
• Input parameters.
  • order - indicates whether the given name comes first or the surname. This is normally specified in the CLDR data for the locale. This feature is also used for the sorting format.
  • length - used to select patterns for common short, medium, and long formatted names.
  • usage - this is used to select the correct pattern to format a name when a program is addressing or talking to a person or it is referring to or talking about another person.
  • formality - This is used to select the formal or informal formatting of a name.
  • See [Person Name Attributes] for more details.

Example Usage

As an example, consider a person’s name that may contain:

If the selected personName data has the following formatting pattern:

{title} {given} {given2-initial} {surname}, {credentials}

Then the output is:

Robin F. Wang, Ph.D.

The title field is empty, so both it and the space that follows it in the formatting pattern are omitted from the output, the given2 field is formatted as an initial, and a preceding comma is placed before the credentials.

Sections below specify the precise manner in which a pattern is selected, and how the pattern is modified for missing fields.

XML Structure

Person name formatting data is stored as LDML with schema defined as follows. Each element has a brief description of the usage, but the exact algorithms for using these elements are provided in Formatting Process.

personNames Element

<!ELEMENT personNames ( nameOrderLocales*, foreignSpaceReplacement?, initialPattern*, personName+, sampleName* ) >

The LDML top-level <personNames> element contains information regarding the formatting of person names, and the formatting of person names in specific contexts for a specific locale.

personName Element

The <personName> element contains the format patterns, or <namePattern> elements, for a specific context and is described in [namePattern Syntax]

The <namePattern> syntax is described in [Person Name Format Patterns].

<!ELEMENT personName ( namePattern+ ) >
<!ATTLIST personName order NMTOKEN #IMPLIED >

• NMTOKEN is one of ( surnameFirst | givenFirst | sorting )

<!ATTLIST personName length NMTOKEN #IMPLIED >

• NMTOKEN is one of ( long | medium | short )

<!ATTLIST personName usage NMTOKEN #IMPLIED >

• NMTOKEN is one of ( addressing | referring | monogram )

<!ATTLIST personName formality NMTOKEN #IMPLIED >

• NMTOKEN is one of ( formal | informal )

The <personName> element has attributes of order, length, usage, and formality, and contains one or more <namePattern> elements.

A missing attribute matches all valid values for that attribute. For example, if formality=... is missing, it is equivalent to multiple lines, one for each possible formality attribute.

<!ELEMENT namePattern ( #PCDATA ) >

A namePattern contains a list of PersonName fields enclosed in curly braces, separated by literals, such as:

<namePattern>{surname}, {given} {given2}</namePattern>

which produces output like “Smith, Robert James”. See [namePattern Syntax] for more details.

nameOrderLocales Element

The <nameOrderLocales> element is optional, and contains information about selecting patterns based on the locale of a passed in PersonName object to determine the order of elements in a formatted name. For more information see [NameOrder]. It has a structure as follows:

<!ELEMENT nameOrderLocales `( #PCDATA )`>
<!ATTLIST nameOrderLocales order ( givenFirst | surnameFirst ) #REQUIRED >

• #PCDATA is a space delimited list of one or more unicode_locale_ids. Normally each locale is limited to language, script, and region. The und locale ID may only occur once, either in surnameFirst or givenFirst, but not both, and matches all base locales not explicitly listed.

An example from English may look like the following

<nameOrderLocales order="givenFirst">und en</nameOrderLocales>
<nameOrderLocales order="surnameFirst">ko vi yue zh</nameOrderLocales>

This would tell the formatting code, when handling person name data from an English locale, to use patterns with the givenFirst order attribute for all data except name data from Korean, Vietnamese, Cantonese, and Chinese locales, where the surnameFirst patterns should be used.

foreignSpaceReplacement Element

The <foreignSpaceReplacement> element is used to specify how spaces should be handled when the name language is different from the formatting language.

<!ELEMENT foreignSpaceReplacement ( #PCDATA ) >
<!ATTLIST foreignSpaceReplacement xml:space preserve #REQUIRED >

• xml:space must be set to 'preserve' so that actual spaces in the pattern are preserved. See W3C XML White Space Handling.
• The #PCDATA is the character sequence used to replace spaces when postprocessing a pattern.

initialPattern Element

The <initialPattern> element is used to specify how to format initials of name parts.

initial is a pattern used to display a single initial in the locale, while initialSequence is a pattern used to “glue” together multiple initials for multiword fields, for example with the given name “Mary Beth” in English.

Syntax

<!ELEMENT initialPattern ( #PCDATA ) >
<!ATTLIST initialPattern type ( initial | initialSequence) #REQUIRED >

The type="initial" is used to specify the pattern for how single initials are created, for example “Wolcott” => “W.” would have an entry of

<initialPattern type="initial">{0}.</initialPattern>

type="initialSequence” is used to specify how a series of initials should appear, for example “Wolcott Janus” => “W. J.”, with spaces between each initial, would have a specifier of

<initialPattern type="initialSequence">{0} {1}</initialPattern>

Person Name Object

The information that is to be formatted logically consists of a data object containing a number of fields. This data object is a construct for the purpose of formatting, and doesn’t represent the source of the name data. That is, the original source may contain more information. The PersonName object is merely a logical ‘transport’ of information to formatting; it may in actuality consist of, for example, an API that fetches fields from a database.

Note that an application might have more than one set of name data for a given person, such as data for both a legal name and a nickname or preferred name. Or the source data may contain two whole sets of name data for a person from an Eastern Slavic region, one in Cyrillic characters and one in Latin characters. Or it might contain phonetic data for a name (commonly used in Japan). The additional application-specific information in person’s names is out of scope for the CLDR Person Name formatting data. Thus a calling application may produce more than one PersonName object to format depending on the purpose.

For illustration, the following is a sample PersonName object.

A PersonName object is logically composed of the fields above plus other possible variations. See [Fields]. There must be at least one field present: either a given or surname field. Other fields are optional, and some of them can be constructed from other fields if necessary.

A modifier is supplied, -informal, which can be used to indicate which data element to choose when formatting informal cases which might include nicknames or preferred names. For more details, see section on [Modifiers] in namePattern Syntax below.

Person Name Attributes

A person name pattern may have any of four attributes: order, length, usage, and formality. LDML specifies that all the values for these attributes are unique. For example, because length=long is valid, usage=long cannot also be valid. That allows the pattern labels to be simple, because the attribute names can be skipped. That is,

{order=givenFirst, length=long, usage=referring, formality=formal}

can be abbreviated without loss of information as:

givenFirst-long-referring-formal.

Each of these attributes are described below using sample PersonName objects as examples.

order

The order attribute is used for patterns with different orders of fields. The order=sorting patterns are chosen based on input parameters, while the choice between givenFirst and surnameFirst is based on features of the PersonName object to be formatted and the nameOrder element values.

For example, when the display language is Japanese, it is customary to use surnameFirst for names of people from Japan and Hungary, but use givenFirst for names of people from the United States and France. Although the English pattern for sorting is distinct from the other patterns (except for unusual names), that is not necessarily the case in other languages.

length

The length attribute specifies the relative length of a formatted name depending on context. For example, a long formal name in English might include title, given, given2, surname plus generation and credentials; whereas a short informal name may only be the given name.

Note that the formats may be the same for different lengths depending on the formality, usage, and cultural conventions for the locale. For example, medium and short may be the same for a particular context.

usage

The usage indicates if the formatted name is being used to address someone, refer to someone, or present their name in an abbreviated form.

The pattern for usage="referring" may be the same as the pattern for usage="addressing".

Slavic languages provide a good example of addressing vs referring. An example uk-Cyrl PersonName object:

In Slavic languages, when addressing a person (with length="long"), it might be

• г-н Иван Петрович Васильев // "Mr Ivan Petrovich Vasiliev"

And when referring to a person, it might place the surname first.:

• Васильев Иван Петрович // "Vasiliev Ivan Petrovich"

The monogram usage is for very short abbreviated names, such as might be found in online messaging text avatars or other annotations. Ideally, a monogram format should result in something that could fit in an em square. Some emoji provide examples of this: 🅰️ 🆎 🆘

When used with length, for many alphabetic locales a monogram would resolve to one, two, or three characters for short, medium, and long respectively. But that may vary depending on the usage in a locale.

formality

The formality indicates the formality of usage. A name on a badge for an informal gathering may be much different from an award announcement at the Nobel Prize Ceremonies.

Note that the formats may be the same for different formality scenarios depending on the length, usage, and cultural conventions for the locale. For example short formal and short informal may both be just the given name.

namePattern Syntax

A namePattern is composed of a sequence of field IDs, each enclosed in curly braces, and separated by zero or more literal characters (eg, space or comma + space). An Extended Backus Normal Form (EBNF) is used to describe the namePattern format for a specific set of attributes. It has the following structure. This is the ( #PCDATA ) reference in the element specification above.

Fields

The Person Name formatting data assumes that the name data to be formatted consists of the fields in the table below. All of the fields may contain multiple words. Field IDs are lowercase ASCII alphanumeric, and start with an alphabetic character.

When determining how a full name is to be placed into name fields, the data to be formatted should be organized functionally. That is, if a name part is on the dividing line between given2 and given, the key feature is whether it would always occur with the rest of the given name. For example, in “Mary Jean Smith”, if “Mary” never occurs without the “Jean”, then the given name should be “Mary Jean”. If “Smith” never occurs without the “Jean”, the surname should be “Jean Smith”. Otherwise, “Jean” would be the given2 field.

For example, a patronymic would be treated as a given2 name in most slavic languages.

In some cultures, two surnames are used to indicate the paternal and maternal family names or generational names indicating father, grandfather. The surname2 field is used to indicate this. The CLDR PersonName formatting data assumes that if a PersonName object to be formatted does not have two surnames, then the surname2 field is not populated. (That is, no pattern should have a surname2 field without a surname field.) Order of fields in a pattern can vary arbitrarily by locale.

In most cultures, there is a concept of nickname or preferred name, which is used in informal settings or sometimes to represent a “public” or “stage name”. The nickname or preferred name may be submitted as a separate PersonName object to be formatted, or included with a modifier such as given-informal.

Some other examples:

• British name: John Ronald Reuel Tolkien: given name is "John", given2 name would be "Ronald Reuel", and the surame is "Tolkien".
• Dutch name: Anneliese Louise van der Pol: given name: "Anneliese", given2 name: "Louise", surname: "van der Pol"
  • Also surname-prefix: “van der”, surname-core: “Pol” — see below.
• French name: “Jean-Louis Trintignant” would not be Jean (given) Louis (given2) Trintignant (surname), since “Louis” wouldn’t be discarded when formatting. Instead it would be Jean-Louis (given) Trintignant (surname)

Note: If the legal name, stage name, etc. are substantially different, then that information can be logically in a separate PersonName object. That is, it is up to the implementation to maintain any distinctions that are important to it: CLDR PersonName formats is focusing on formatting a PersonName object that is given to it.

surname2 would only be asked for in certain locales, and where it is considered a separate, divisible name, such as in Mexico or Spain. For instance, in Mexico, the first and second surname are used for the legal name and in formal settings, and sometimes only the first surname is used in familiar or informal contexts.

• Heathcote-Drummond is a single surname and would not be {surname}-{surname2} because we would never discard part of the name when formatting.
• Spanish name: "Jose Luis Garcia Barrientos": The given name is “Jose”, the given2 name is “Luis”, the surname is "Garcia”, and the surname2 is “Barrientos"

How names get placed into fields to be formatted is beyond the scope of CLDR PersonName formats; this document just lays out the assumptions the formatting code makes when formatting the names.

Modifiers

Each field in a pattern can have one or more modifiers. The modifiers can be appended to any field name, such as {given-initial} for the first grapheme of the given name. If more than one modifier is applied, they must be structured as in the EBNF.

The modifiers transform the input data as described in the following table:

There may be more modifiers in the future.

Examples:

1. For the initial of the surname “de Souza”, in a language that treats the “de” as a tussenvoegsel, the PersonName object can automatically recast {surname-initial} to:
   {surname-prefix-initial}{surname-core-initial-allCaps} to get “dS” instead of “d”.
2. If the locale expects a surname prefix to to be sorted after a surname, then both {surname-core} then {surname-prefix} would be used as in
   {surname-core}, {given} {given2} {surname-prefix}

Formatting Process

The patterns are in personName elements, which are themselves in a personNames container element. The following describes how the formatter's locale interacts with the personName's locale, how the name patterns are chosen, and how they are processed.

The details of the XML structure behind the data referenced here are in XML Structure.

The formatting process may be refined in the future. In particular, additional data may be added to allow further customization.

The term maximal likely locale used below is the result of using the Likely Subtags data to map from a locale to a full representation that includes the base language, script, and region.

Derive the name locale

Construct the name script in the following way.

1. Iterate through the characters of the surname, then through the given name.
   1. Find the script of that character using the Script property.
   2. If the script is not Common, Inherited, nor Unknown, return that script as the name script
2. If nothing is found during the iteration, return Zzzz (Unknown Script)

Construct the name base language in the following way.

1. If the PersonName object can provide a name locale, return its language.
2. Otherwise, find the maximal likely locale for the name script and return its base language (first subtag).

Construct the name locale in the following way:

1. If the PersonName object can provide a name locale, return a locale formed from it by replacing its script by the name script.
2. Otherwise, return the locale formed from the name base language plus name script.

Derive the formatting locale

Let the full formatting locale be the maximal likely locale for the formatter's locale. The formatting base language is the base language (first subtag) of the full formatting locale, and the formatting script is the script code of the full formatting locale.

Switch the formatting locale if necessary

A few script values represent a set of scripts, such as Jpan = {Hani, Kana, Hira}. Two script codes are said to match when they are either identical, or one represents a set which contains the other, or they both represent sets which intersect. For example, Hani and Jpan match, because {Hani, Kana, Hira} contains Hani.

If the name script doesn't match the formatting script, then the name is formatted with the name locale, not the originally requested formatting locale. For example, when a Hindi formatter (hi-Deva) is called upon to format a name with the Ukrainian (Cyrillic) locale (uk-Cyrl), under the covers a Ukrainian (Cyrillic) formatter should be instantiated and used to format that name.

Derive the name order

A PersonName object’s fields are used to derive an order, as follows:

1. If the calling API requests sorting order, that is used.
2. Otherwise, if the PersonName object to be formatted has a preferredOrder field, then return that field’s value
3. Otherwise, use the nameOrderLocales elements to find the best match for the name locale, as follows.
   1. For each locale L1 in the parent locale lookup chain* for the name object’s locale, do the following
      1. Create a locale L2 by replacing the language subtag by 'und'. (Eg, 'de_DE' ⇒ 'und_DE')
      2. For each locale L in {L1, L2}, do the following
         1. If there is a precise match among the givenFirst nameOrderLocales for L, then let the nameOrder be givenFirst, and stop.
         2. Otherwise if there is a precise match among the surnameFirst nameOrderLocales for L, then let the nameOrder be surnameFirst, and stop.

* For example, here is a parent locale lookup chain:

de_Latn_DE ⇒ de_Latn ⇒ de_DE ⇒ de ⇒ und

In other words, with the name locale of de_Latin_DE you'll check the givenFirst and surnameFirst resources for the following locales, in this order:

de_Latin_DE, und_Latn_DE, de_Latn, und_Latn, de_DE, und_DE, de, und

This process will always terminate, because there is always a und value in one of the two nameOrderLocales elements. Remember that the lookup chain requires use of the parentLocales elements: it is not just truncation.

For example, the data for a particular locale might look like the following:

<nameOrderLocales order="surnameFirst">zh ja und-CN und-TW und-SG und-HK und-MO und-HU und-JP</nameOrderLocales>

These nameOrderLocales will match any locale with a zh or ja unicode_language_subtag and any locale with a CN, TW, SG, HK MO, HU, or JP unicode_region_subtag.

Here are some more examples. Note that if there is no order field or locale field in the PersonName object to be formatted, and the script of the PersonName data is different from that of the formatting locale, then the default result is givenFirst.

Choose a personName element

The personName data in CLDR provides representations for how names are to be formatted across the different axes of order, length, usage, and formality. More than one namePattern can be associated with a single personName entry. An algorithm is then used to choose the best namePattern to use.

As an example for English, this may look like:

<personNames>
  <personName order="givenFirst" length="long" usage="referring" formality="formal">
    <namePattern>{title} {given} {given2} {surname}, {credentials}</namePattern>
  </personName>
  <personName order="givenFirst" length="long" usage="referring" formality="informal">
    <namePattern>{given} «{given2}» {surname}</namePattern>
    <namePattern alt="2">«{given2}» {surname}</namePattern>
  </personName>
  <personName order="givenFirst" length="long" usage="sorting" formality="informal">
    <namePattern>{surname}, {given} {given2}</namePattern>
  </personName>
  ...
</personNames>

The task is to find the best personName for a given set of input attributes. Well-formed data will always cover all possible combinations of the input parameters, so the algorithm is simple: traverse the list of person names until the first match is found, then return it.

In more detail:

A set of input parameters { order=O length=L usage=U formality=F } matches a personName element when:

• The order attribute values contain O or there is no order attribute, and
• The length attribute values contain L or there is no length attribute, and
• The usage attribute values contain U or there is no usage attribute, and
• The formality attribute values contain F or there is no formality attribute

Example for input parameters

order = givenFirst, length = long, usage = referring, formality = formal

To match a personName, all four attributes in the personName must match (a missing attribute matches any value for that attribute):

To find the matching personName element, traverse all the personNames in order until the first one is found. This will always terminate since the data is well-formed in CLDR.

Choose a namePattern

To format a name, the fields in a namePattern are replaced with fields fetched from the PersonName Data Interface. The personName element can contain multiple namePattern elements. Choose one based on the fields in the input PersonName object that are populated:

1. Find the set of patterns with the most populated fields.
2. If there is just one element in that set, use it.
3. Otherwise, among that set, find the set of patterns with the fewest unpopulated fields.
4. If there is just one element in that set, use it.
5. Otherwise, take the pattern that is alphabetically least. (This step should rarely happen, and is only for producing a determinant result.)

For example:

1. Pattern A has 12 fields total, pattern B has 10 fields total, and pattern C has 8 fields total.
2. Both patterns A and B can be populated with 7 fields from the input PersonName object, pattern C can be populated with only 3 fields from the input PersonName object.
3. Pattern C is discarded, because it has the least number of populated name fields.
4. Out of the remaining patterns A and B, pattern B wins, because it has only 3 unpopulated fields compared to pattern A.

Access PersonName object

Handle missing surname

All PersonName objects will have a given name (for mononyms the given name is used). However, there may not be a surname. In that case, the following process is followed so that formatted patterns produce reasonable results.

1. If there is no surname from a PersonName P1 and the pattern either doesn't include the given name or only shows an initial for the given name, then:
   1. Construct and use a derived PersonName P2, whereby P2 behaves exactly as P1 except that:
      1. Any request for a surname field (with any modifiers) returns P1's given name (with the same modifiers)
      2. Any request for a given name field (with any modifiers) returns "" (empty string)

As always, this is a logical description and may be optimized in implementations. For example, an implemenation may use an interface for P2 that just delegates calls to P1, with some redirection for accesses to surname and given name.

Handle core and prefix

A given field may have a core value, a prefix value, and/or a ‘plain’ value (neither core nor prefix). If one or more of them are missing, then the returned values should be adjusted according to the table below. In the three cells on the left, a ✓ indicates that a value is available, an ✖️ if there is none. In three cells on the right, the value of = means the returned value is unchanged, ✖️ means the returned value is “empty”, and anything else is a description of what to change it to.

For example, if the surname-prefix is "von und zu" and the surname-core is "Stettbach" and there is no surname (plain), then the derived value for the (plain) surname is "von und zu Stettbach". (The cases where existing prefix values are changed should not be necessary with well-formed PersonName data.)

Derive initials

The following process is used to produce initials when they are not supplied by the PersonName object. Assuming the input example is “Mary Beth”:

See the “initial” modifier in the Modifiers section for more details.

Process a namePattern

The “winning” namePattern may still have fields that are unpopulated (empty) in the PersonName object. That namePattern is populated with field values with the following steps:

1. If one or more fields at the start of the pattern are empty, all fields and literal text before the first populated field are omitted.
2. If one or more fields at the end of the pattern are empty, all fields and literal text after the last populated field are omitted.
3. Processing from the start of the remaining pattern:
   1. If there are two or more empty fields separated only by literals, the fields and the literals between them are removed.
   2. If there is a single empty field, it is removed.
4. If the processing from step 3 results in two adjacent literals (call them A and B), they are coalesced into one literal as follows:
   1. If either is empty the result is the other one.
   2. If B matches the end of A, then the result is A. So xyz + yz ⇒ xyz, and xyz + xyz ⇒ xyz.
   3. Otherwise the result is A + B, further modified by replacing any sequence of two or more white space characters by the first whitespace character.
5. All of the fields are replaced by the corresponding values from the PersonName object.

The result is the formatted value. However, there is one further step that might further modify that value.

Handling foreign names

There are two main challenges in dealing with foreign name formatting that needs to be considered. One is the ordering, which is dealt with under the section nameOrderLocales Element]. The other is spacing.

Some writing systems require spaces (or some other non-letters) to separate words. For example, Hayao Miyazaki is written in English with given name first and with a space between the two name fields, while in Japanese there is no space with surname first: 宮崎駿

If a locale requires spaces between words, the normal patterns for the formatting locale are used. On Wikipedia, for example, note the space within the Japanese name on pages from English and Korean (an ideographic space is used here for emphasis).

• “​​Hayao Miyazaki (宮崎　駿, Miyazaki Hayao…” or
• “미야자키　하야오(일본어: 宮﨑　駿 Miyazaki Hayao…”.

If a locale doesn’t require spaces between words, there are two cases, based on whether the name is foreign or not (based on the PersonName objects explicit or calculated locale's language subtag). For example, the formatting locale might be Japanese, and the locale of the PersonName object might be de_CH, German (Switzerland), such as Albert Einstein. When the locale is foreign, the foreignSpaceReplacement is substituted for each space in the formatted name. When the name locale is native, a nativeSpaceReplacement is substituted for each space in the formatted name. The precise algorithm is given below.

Here are examples for Albert Einstein in Japanese and Chinese:

• アルベルト・アインシュタイン
• 阿尔伯特·爱因斯坦

Setting the spaceReplacement

1. The foreignSpaceReplacement is provided by the value for the foreignSpaceReplacement element; the default value is " ".
2. The nativeSpaceReplacement is determined by the following algorithm, choosing between " " and "".
   1. Get the script of the formatting locale
   2. If the likely script is Thai, let nativeSpaceReplacement = " " (space)
   3. Otherwise let nativeSpaceReplacement = "" (empty string) if either of the following applies:
      1. The script is Jpan, Hant, or Hans
      2. The script has the script metadata property lbLetters = YES (this can also be algorithmically derived from the LineBreak property data).
   4. Otherwise, let nativeSpaceReplacement = " " (space)
3. If the formatter base language matches the name base language, then let spaceReplacement = nativeSpaceReplacement, otherwise let spaceReplacement = foreignSpaceReplacement.
4. Replace all sequences of space in the formatted value string by the spaceReplacement.

For the purposes of this algorithm, two base languages are said to match when they are identical, or if both are in {ja, zh, yue}.

Note: in the future the plan is to make the specific languages and scripts used in this algorithm be data-driven.

Remember that a name in a different script will use a different locale for formatting, as per Switch the formatting locale if necessary. For example, when formatting a name for Japanese, if the name is in the Latin script, a Latin based locale will be used to format it, such as when “Albert Einstein” appears in Latin characters as in the Wikipedia page Albert Einstein.

Examples of space replacement

To illustrate how foreign space replacement works, consider the following name data. For illustration, the name locale is given in the maximized form: in practice, ja would be used instead of ja_Jpan_JP, and so on.: For more information, see Likely Subtags.

Suppose the PersonNames formatting patterns for ja_JP and de_CH contained the following:

ja_JP formatting patterns

<personNames>
   <nameOrderLocales order="givenFirst">und</nameOrderLocales>
   <nameOrderLocales order="surnameFirst">hu ja ko vi yue zh und_JP</nameOrderLocales>
   <foreignSpaceReplacement xml:space="preserve">・</foreignSpaceReplacement>
   . . .
   <personName order="givenFirst" length="medium" usage="referring" formality="formal">
      <namePattern>{given} {given2} {surname}{generation}</namePattern>
   </personName>
   . . .
   <personName order="surnameFirst" length="medium" usage="referring" formality="formal">
      <namePattern>{surname}{given2}{given}{generation}</namePattern>
   </personName>
   . . .
</personNames>

Note in the de_CH locale, ja is not listed in nameOrderLocales, and would therefore fall under und, and be formatted using the givenFirst order patterns if the name data is in the same script as the formatting locale.

de_CH formatting patterns

<personNames>
   <nameOrderLocales order="givenFirst">und de</nameOrderLocales>
   <nameOrderLocales order="surnameFirst">ko vi yue zh</nameOrderLocales>
   <foreignSpaceReplacemen xml:space="preserve"> </foreignSpaceReplacement>
   . . .
   <personName order="givenFirst" length="medium" usage="referring" formality="formal">
      <namePattern>{given} {given2-initial} {surname}, {generation}</namePattern>
   </personName>
   . . .
   <personName order="surnameFirst" length="medium" usage="referring" formality="formal">
      <namePattern>{surname}, {given} {given2-initial}, {generation}</namePattern>
   </personName>
   . . .
</personNames>`

The name data would resolve as follows:

Formatting examples

The personName element contains:

<namePattern>{title} {given} {given2} {surname}, {credentials}</namePattern>

The input PersonName object contains:

The output is:

Raymond J. Johnson, Jr.

The “title” field is empty, and so both it and the space that follows it are omitted from the output, according to rule 1 above.

If, instead, the input PersonName object contains:

The output is:

Raymond J. Johnson

The “title” field is empty, and so both it and the space that follows it are omitted from the output, according to rule 1 above.

The “generation” field is also empty, so it and both the comma and the space that precede it are omitted from the output, according to rule 2 above.

To see how rule 3 interacts with the other rules, consider an imaginary language in which people generally have given and given2 (or middle) names, and the given2 name is always written with parentheses around it, and the given name is usually written as an initial with a following period.

The personName element contains:

<namePattern>{given-initial}. ({given2}) {surname}</namePattern>

The input PersonName object contains:

The output is:

F. (Bar) Baz

If, instead, the input PersonName object contains:

The output is:

F. Baz

The “given2” field is empty, so it and the surrounding parentheses are omitted from the output, as is one of the surrounding spaces, according to rule 3. The period after “{given-initial}” remains, because it is separated from the “{given2}” element by space-- punctuation around a missing field is only deleted up until the closest space in each direction.

If there were no space between the period and the parentheses, as might happen if our hypothetical language didn’t use spaces:

<namePattern>{given-initial}.({given2}) {surname}</namePattern>

The input PersonName object still contains:

The output is:

F Baz

Both the period after “{given-initial}” and the parentheses around “{given2}” are omitted from the output, because there was no space between them — instead, we delete punctuation all the way up to the neighboring field. To solve this (making sure the “{given-initial}” field always has a period after it), you would add another namePattern:

<namePattern>{given-initial}.({given2}) {surname}</namePattern>
<namePattern alt=”2”>{given-initial}. {surname}</namePattern>

The first pattern would be used when the “given2” field is populated, and the second pattern would be used when the “given2” field is empty.

Rules 1 and 3 can conflict in similar ways. If the personName element contains (there’s a space between the period and the opening parenthesis again):

<namePattern>{given-initial}. ({given2}) {surname}</namePattern>

And the input PersonName object contains:

The output is:

Bar) Baz

Because the “given” field is empty, rule 1 not only has us delete it, but also all punctuation up to “{given2}”. This includes both the period and the opening parenthesis. Again, to solve this, you’d supply two namePatterns:

<namePattern>{given-initial}. ({given2}) {surname}</namePattern>
<namePattern alt=”2”> ({given2}) {surname}</namePattern>

The output would then be:

(Bar) Baz

The first namePattern would be used if the “given” field was populated, and the second would be used if it was empty.

If, instead, the input PersonName object contains:

The output is:

F. Baz

Sample Name

The sampleName element is used for test names in the personNames LDML data for each locale to aid in testing and display in the CLDR Survey Tool. They are not intended to be used in production software as prompts or placeholders in a user interface and should not be displayed in a user interface.

Syntax

<!ELEMENT sampleName ( nameField+ )  >
<!ATTLIST sampleName item NMTOKEN #REQUIRED >

• NMTOKEN must be one of ( nativeG, nativeGS, nativeGGS, nativeFull, foreignG, foreignGS, foreignGGS, foreignFull ). However, these may change arbitrarily in the future.

Expected values

The item values starting with "native" are expected to be native names, in native script. The item values starting with "foreign" are expected to be foreign names, in native script. There are no foreign names or native names in a foreign script, because those should be handled by a different locale's data.

The rest of the item value indicates how many fields are present. For the expected sample name items, assume a name such as Mr. Richard “Rich” Edward Smith Iglesias Ph.D.

• G is for an example name with only the given is presented: “Richard” or “Rich” (informal)
• GS is for an example name with only the given name and surname: “Richard Smith” or “Rich Smith” (informal)
• GSS is for an example using both given and given2 names and a surname: “Richard Edward Smith” and “Rich E. Smith” (informal)
• Full is used to present a name using all possible fields: “Mr. Richard Edward Smith Iglesias, Ph.D.”

The nameField values and their modifiers are described in the Person Name Object and namePattern Syntax sections.

PersonName Data Interface Examples

Example 1

Greek initials can be produced via the following process in the PersonName object, and returned to the formatter.

• Include all letters up through the first consonant or digraph (including the consonant or digraph).
  (This is a simplified version of the actual process.)

Examples:

• Χριστίνα Λόπεζ (Christina Lopez) ⟶ Χ. Λόπεζ (C. Lopez)
• Ντέιβιντ Λόπεζ (David Lopez) ⟶ Ντ. Λόπεζ (D. Lopez)
  Note that Ντ is a digraph representing the sound D.

Example 2

To make an initial when there are multiple words, an implementation might produce the following:

• A field containing multiple words might skip some of them, such as in “Mohammed bin Ali bin Osman” (“MAO”).
• The short version of "Son Heung-min" is "H. Son" and not "H. M. Son" or the like. Korean given-names have hyphens and the part after the hyphen is lower-case.

Copyright © 2001–2023 Unicode, Inc. All Rights Reserved. The Unicode Consortium makes no expressed or implied warranty of any kind, and assumes no liability for errors or omissions. No liability is assumed for incidental and consequential damages in connection with or arising out of the use of the information or programs contained or accompanying this technical report. The Unicode Terms of Use apply.

Unicode and the Unicode logo are trademarks of Unicode, Inc., and are registered in some jurisdictions.