Template:Family name hatnote

Template documentation[view] [edit] [history] [purge]

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. However, never use both. 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 Wikipedia 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 Template:Xtn is one article and Template:Xtn is another), or where a footnotes system would have to be introduced for the explanation.

Footnotes ({{Family name footnote}}) 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	Ijebu Kingdom
Lebanese	Lebanese Arabic
Ottoman Turkish	Ottoman Turkish
Romance	Romance language
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	{{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	{{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	{{Family name hatnote|Oboi|Gūwalgiya|lang=Manchu}}
Medieval	{{Family name hatnote|Wolfram|von Eschenbach|lang=Medieval}}
Mongolian	{{Family name hatnote|Tsedenbal|Yumjaagiin|lang=Mongolian}}
ni-Vanuatu	{{Family name hatnote|Natapei|Rapi|lang=Ni-Vanuatu}}
Ottoman Turkish	{{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	{{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	{{Family name hatnote|Chan|Jackie|Kong-sang|lang=Hong Kong}}
Macau	Template:Txl
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)	{{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 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.

Parameter		Description	Type	Status
Surname or family name	1	The primary element in the person's surname	String	required
Additional name element	2	Secondary element in the person's surname (depending upon language)	String	suggested
Additional name element	3	Tertiary element in the person's surname or transliteration (depending upon language)	String	suggested
Language	lang	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 Medieval Mongolian Ni-Vanuatu Ottoman Turkish Romance Slavic Spanish Toponymic Turkic Vietnamese Hong Kong Macau Example lang=Spanish (not lang=es)	String	suggested
Dutch marital name	nd	Use only with Dutch surnames where the person's married name is to be specified	String	suggested
Explanation type	type	Whether the explanation should be rendered as a footnote, a hatnote, or neither (default). Suggested values footnote hatnote Default Neither	String	optional
Reference group type	reftype	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	Line	optional

Notes

Tracking categories

• Category:Pages using family name hatnote with no first parameter (0)

See also

• WP:SUR

• {{Bhutanese name}}
• {{British barrelled name}}
• {{Dinka name}}
• {{Ethiopian name}}
• {{Fijian name}}
• {{Given name hatnote}}
• {{Icelandic name}}
• {{Indian patronymic}}
• {{Indonesian name}}
• {{Malay name}}
• {{Norse name}}
• {{Patronymic name}}
• {{Pakistani name}}
• {{Philippine name}}
• {{Portuguese name}}
• {{Spanish colonial name}}
• {{Spanish married name}}
• {{Traditional Norwegian name}}
• {{Western name order}} (primarily relevant to Hungarian names)
• {{Western Slavic name}}

The above documentation is transcluded from Template:Family name hatnote/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.