Template:Family name hatnote/doc

Template page

Template:Family name hatnote is placed at the top of a biographical article to explain to readers which part of a name is the family name.

Usage

Parameter Description Status
|1= The surname or family name of the subject. Required
|2= Triggers different text based on the language (see below). Required for |lang=Manchu; optional for others.
|3= For transliterated names or there are multiple name types. Optional
|nd= Use for Dutch names when a marital name is involved Conditional
|lang= The country or origin of the name; links to related articles if they exist.
Note: language names must be spelled out, not ISO codes, for example Spanish not es.
Optional

Footnotes vs. hatnotes

There is no universal consensus on whether to use footnotes or hatnotes for family name explanations.[lower-alpha 1] However, never use both.[lower-alpha 2] For names that are clear to the average reader, such as Jeremy Lin, use no explanation.

Hatnotes are a high-emphasis method of name explanation, and have been used widely on OODA WIKI for many years. Some editors argue that they are well-suited to articles where the name is particularly in need of clarification (such as when the name

  1. REDIRECT Template:xtn

Foo Bar is one article and

  1. REDIRECT Template:xtn

Bar Foo is another), or where a footnotes system would have to be introduced for the explanation.

Footnotes are a newer, lower-emphasis method of name explanation introduced in 2020. Some editors argue that they better avoid giving undue prominence to name explanations. Others argue that they fit name explanations better as they do not muddle the navigational purpose of hatnotes. They may be particularly well-suited to articles that already have other hatnotes (where another might induce banner blindness), or where there is a preexisting footnote system (and thus no need to introduce one).

Supported languages

The |lang= parameter will trigger a link to <lang> name (for example, Arabic name) if the page exists. Exceptions are listed below:

Language Article
Eastern Slavic Eastern Slavic naming customs
Hmong Hmong people
Ijebu Yoruba name
Lebanese Lebanese Arabic
Ottoman Turkish Ottoman Turkish language
Romance Romance languages
Toponymic third parameter is linked
Turkic Turkic languages

Examples

First parameter only

Regardless of language, this template requires a first parameter for the given surname. For instances where the language may not commonly use a family name, the text reflects this.

Language Code Example Output
No |lang= set {{Family name hatnote|Simpson}}
Burmese {{Family name hatnote|Htang|lang=Burmese}}
Dutch {{Family name hatnote|Van der Sar|lang=Dutch}}
Ijebu {{Family name hatnote|Àjàyí|lang=Ijebu}}
Mongolian {{Family name hatnote|Tsedenbal|lang=Mongolian}}
Ottoman Turkish {{Family name hatnote|Namık Kemal|lang=Ottoman Turkish}}

Second parameter

The second parameter triggers different wording depending on the language.

Language Code Example Output
Argentine {{Family name hatnote|Acosta|Benitez|lang=Argentine}}
Basque {{Family name hatnote|Arana|Goiri|lang=Basque}}
Bulgarian {{Family name hatnote|Ivanova|Georgieva-Kinova|lang=Bulgarian}}
Cambodian[lower-alpha 3] {{Family name hatnote|Sok|Narvaratt|lang=Cambodian}}
Catalan {{Family name hatnote|Miró|Ferrà|lang=Catalan}}
Chilean {{Family name hatnote|Ocampo|Soto|lang=Chilean}}
Chinese {{Family name hatnote|Wang|De|lang=Chinese}}
Chinese Indonesian {{Family name hatnote|Han|Su|lang=Chinese Indonesian}}
Congolese {{Family name hatnote|Tshisekedi|Tshilombo|lang=Congolese}}
Dutch {{Family name hatnote|Van der Sar|Sar|lang=Dutch}}
Dutch (if |nd=y) {{Family name hatnote|Noordewier|Reddingius|nd=yes|lang=Dutch}}
Eastern Slavic {{Family name hatnote|Aleksandrovitch|Imyarek|lang=Eastern Slavic}}
Galician {{Family name hatnote|Núñez|Castillo|lang=Galician}}
German {{Family name hatnote|Von Allmen|Allmen|lang=German}}
Hmong[lower-alpha 3] {{Family name hatnote|Kaying|Pha|lang=Hmong}}
Korean {{Family name hatnote|Lee|Han|lang=Korean}}
Lebanese Arabic {{Family name hatnote|Ali|Maatouk|lang=Lebanese}}
Manchu[lower-alpha 4] {{Family name hatnote|Oboi|Gūwalgiya|lang=Manchu}}
Mongolian {{Family name hatnote|Tsedenbal|Yumjaagiin|lang=Mongolian}}
ni-Vanuatu {{Family name hatnote|Natapei|Rapi|lang=Ni-Vanuatu}}
Ottoman Turkish[lower-alpha 5] {{Family name hatnote|Osman Hamdi|Bey|lang=Ottoman Turkish}}
Romance {{Family name hatnote|de Perier|Perier|lang=Romance}}
Slavic {{Family name hatnote|Wołkowski|Wolkowski|lang=Slavic}}
Spanish {{Family name hatnote|Gómez|Cruz|lang=Spanish}}
Turkic {{Family name hatnote|Bölükbaşı|Bolukbasi|lang=Turkic}}
Vietnamese[lower-alpha 3][lower-alpha 6] {{Family name hatnote|Phan|Khải|lang=Vietnamese}}
All others
(A, not B)
{{Family name hatnote|Wilson|Clark}}

Third parameter

With the exception of |lang=Toponymic, the third parameter is used for transliterated names or a second name type.

Language Code Example Output
Hong Kong[lower-alpha 7] {{Family name hatnote|Chan|Jackie|Kong-sang|lang=Hong Kong}}
Macau[lower-alpha 7][lower-alpha 8] {{Family name hatnote|Ho|Edmund|Hau Wah|lang=Macau}}
Manchu {{Family name hatnote|Hūlušun|Nara|Hulusun|lang=Manchu}}
Ottoman Turkish {{Family name hatnote|Ali|Pasha|Çandarlı|lang=Ottoman Turkish}}
Ottoman Turkish
(if no title)[lower-alpha 9]
{{Family name hatnote|Ali||Çandarlı|lang=Ottoman Turkish}}
Toponymic {{Family name hatnote|London|Edward|English name|lang=Toponymic}}
Vietnamese {{Family name hatnote|Ngô|Diệm|Ngo|lang=Vietnamese}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Family name hatnote

Placed at the top of a biographical article to explain to readers which part of a name is the family name.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Surname or family name1

The primary element in the person's surname

Stringrequired
Additional name element2

Secondary element in the person's surname (depending upon language)

Stringsuggested
Additional name element3

Tertiary element in the person's surname or transliteration (depending upon language)

Stringsuggested
Languagelang

Language or naming convention. Note: Spell out the language name; do not use ISO codes

Suggested values
Argentine Basque Bulgarian Burmese Cambodian Catalan Chilean Chinese Chinese Indonesian Congolese Dutch Eastern Slavic Galician German Hmong Ijebu Korean Lebanese Manchu Mongolian Ni-Vanuatu Ottoman Turkish Romance Slavic Spanish Toponymic Turkic Vietnamese Hong Kong Macau
Example
lang=Spanish (not lang=es)
Stringsuggested
Dutch marital namend

Use only with Dutch surnames where the person's married name is to be specified

Stringsuggested
Explanation typetype

Whether the explanation should be rendered as a footnote, a hatnote, or neither (default).

Suggested values
footnote hatnote
Default
Neither
Stringoptional
Reference group typereftype

Name of footnote template to use, such as efn, efn-lr, or NoteTag.

Suggested values
efn efn-lr efn-ua efn-ur efn-lg NoteTag
Default
efn
Lineoptional

Notes

  1. See OODA WIKI:Village pump (proposals)/Archive 188 § Method of surname clarification.
  2. List of articles to fix.
  3. 3.0 3.1 3.2 For Cambodian, Hmong, or Vietnamese, |2= is not required, and will still add the explanatory note.
  4. The second parameter is required for this language
  5. For Ottoman Turkish, if |3= is given, the family name will be listed as well.
  6. Vietnamese has a "transliterated" message similar to Slavic and Turkic, but is triggered by |3=.
  7. 7.0 7.1 If the full Western- and Chinese-style name is desired, it must be included in the second and third parameter in the proper order; for example Chan|Jackie Chan|Chan Kong-sang.
  8. Also works with the spelling Macao.
  9. For Ottoman Turkish, if |2= is left empty (note the double pipe, ||), "the title is..." section is not included.

Tracking categories

See also