Template:Family name explanation/doc

Template:Family name explanation is placed at the top of a biographical article to explain to readers which part of a name is the family name. It is used by the wrappers {{Family name footnote{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}}} and {{Family name hatnote{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}{{---}}}}. More rarely, it may be invoked directly, e.g. for use within a larger footnote about a person's 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 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 explanation|Simpson}}	In this article, the surname is Simpson.
Burmese	{{Family name explanation|Htang|lang=Burmese}}	In this article, the given name is Htang. There is no family name.
Dutch	{{Family name explanation|Van der Sar|lang=Dutch}}	In this article, the surname is Van der Sar.
Ijebu	{{Family name explanation|Àjàyí|lang=Ijebu}}	In this Ijebu name, the Yoruba surname is Àjàyí.
Mongolian	{{Family name explanation|Tsedenbal|lang=Mongolian}}	In this article, the given name is Tsedenbal. There is neither a patronymic nor a family name.
Ottoman Turkish	{{Family name explanation|Namık Kemal|lang=Ottoman Turkish}}	In this Ottoman Turkish style name, the given name is Namık Kemal. There is no family name.

Second parameter

The second parameter triggers different wording depending on the language.

Language	Code	Example Output
Argentine	{{Family name explanation|Acosta|Benitez|lang=Argentine}}	In this article, the surname is Acosta and the marital name is Benitez.
Basque	{{Family name explanation|Arana|Goiri|lang=Basque}}	In this article, the first surname is Arana and the second is Goiri.
Bulgarian	{{Family name explanation|Ivanova|Georgieva-Kinova|lang=Bulgarian}}	In this article, the patronymic is Ivanova and the family name is Georgieva-Kinova.
Cambodian	{{Family name explanation|Sok|Narvaratt|lang=Cambodian}}	In this article, the surname is Sok. In accordance with Cambodian custom, this person should be referred to by the given name, Narvaratt.
Catalan	{{Family name explanation|Miró|Ferrà|lang=Catalan}}	In this article, the first or paternal surname is Miró and the second or maternal family name is Ferrà; both are generally joined by the conjunction "i".
Chilean	{{Family name explanation|Ocampo|Soto|lang=Chilean}}	In this article, the first or paternal surname is Ocampo and the second or maternal family name is Soto.
Chinese	{{Family name explanation|Wang|De|lang=Chinese}}	In this article, the family name is Wang and De is a generation name.
Chinese Indonesian	{{Family name explanation|Han|Su|lang=Chinese Indonesian}}	In this article, the family name is Han and Su is a generation name.
Congolese	{{Family name explanation|Tshisekedi|Tshilombo|lang=Congolese}}	In this article, the surname is Tshisekedi and the post-surname is Tshilombo.
Dutch	{{Family name explanation|Van der Sar|Sar|lang=Dutch}}	In this article, the surname is Van der Sar, not Sar.
Dutch (if |nd=y)	{{Family name explanation|Noordewier|Reddingius|nd=yes|lang=Dutch}}	In this article, the birth surname is Noordewier and the marital name is Reddingius.
Eastern Slavic	{{Family name explanation|Aleksandrovitch|Imyarek|lang=Eastern Slavic}}	In this name that follows Eastern Slavic naming conventions, the patronymic is Aleksandrovitch and the family name is Imyarek.
Galician	{{Family name explanation|Núñez|Castillo|lang=Galician}}	In this article, the first surname is Núñez and the second is Castillo.
German	{{Family name explanation|Von Allmen|Allmen|lang=German}}	In this article, the surname is Von Allmen, not Allmen.
Hmong	{{Family name explanation|Kaying|Pha|lang=Hmong}}	In this Hmong name, the surname is Kaying. In accordance with Hmong custom, this person should be referred to by the given name, Pha.
Korean	{{Family name explanation|Lee|Han|lang=Korean}}	In this article, the family name is Lee. In the stage name or pen-name, the surname is Han.
Lebanese Arabic	{{Family name explanation|Ali|Maatouk|lang=Lebanese}}	In this Lebanese name, the father's name is Ali and the family name is Maatouk.
Manchu	{{Family name explanation|Oboi|Gūwalgiya|lang=Manchu}}	In this article, the given name is Oboi. In accordance with Manchu custom, it should be used alone or with titles but not with the clan name Gūwalgiya.
Mongolian	{{Family name explanation|Tsedenbal|Yumjaagiin|lang=Mongolian}}	In this article, the given name is Tsedenbal. Yumjaagiin is a patronymic, not a family name.
ni-Vanuatu	{{Family name explanation|Natapei|Rapi|lang=Ni-Vanuatu}}	In this article, the surname is Natapei, and the traditional name is Rapi.
Ottoman Turkish	{{Family name explanation|Osman Hamdi|Bey|lang=Ottoman Turkish}}	In this Ottoman Turkish style name, the given name is Osman Hamdi, the title is Bey, and there is no family name.
Romance	{{Family name explanation|de Perier|Perier|lang=Romance}}	In this Romance language name, the surname is de Perier, not Perier.
Slavic	{{Family name explanation|Wołkowski|Wolkowski|lang=Slavic}}	In this article, the surname is Wołkowski, sometimes transliterated as Wolkowski.
Spanish	{{Family name explanation|Gómez|Cruz|lang=Spanish}}	In this article, the first or paternal surname is Gómez and the second or maternal family name is Cruz.
Turkic	{{Family name explanation|Bölükbaşı|Bolukbasi|lang=Turkic}}	In this Turkic name, the surname is Bölükbaşı, sometimes transliterated as Bolukbasi.
Vietnamese	{{Family name explanation|Phan|Khải|lang=Vietnamese}}	In this article, the surname is Phan. In accordance with Vietnamese custom, this person should be referred to by the given name, Khải.
All others (A, not B)	{{Family name explanation|Wilson|Clark}}	In this article, the surname is Wilson, not 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 explanation|Chan|Jackie|Kong-sang|lang=Hong Kong}}	In this article, the surname is Chan. In accordance with Hong Kong custom, the Western-style name is Jackie and the Chinese-style name is Kong-sang.
Macau	{{Family name explanation|Ho|Edmund|Hau Wah|lang=Macau}}	In this article, the surname is Ho. In accordance with Macau custom, the Western-style name is Edmund and the Chinese-style name is Hau Wah.
Manchu	{{Family name explanation|Hūlušun|Nara|Hulusun|lang=Manchu}}	In this article, the given name is Hūlušun, but is often simplified to Hulusun in English-language text. In accordance with Manchu custom, it should be used alone or with titles but not with the clan name Nara.
Ottoman Turkish	{{Family name explanation|Ali|Pasha|Çandarlı|lang=Ottoman Turkish}}	In this Ottoman Turkish style name, the given name is Ali, the title is Pasha, and the family name is Çandarlı.
Ottoman Turkish (if no title)	{{Family name explanation|Ali||Çandarlı|lang=Ottoman Turkish}}	In this Ottoman Turkish style name, the given name is Ali, and the family name is Çandarlı.
Toponymic	{{Family name explanation|London|Edward|English name|lang=Toponymic}}	In this English name, the toponymic surname is London. It is not a family name, and the person should be referred to by the given name, Edward.
Vietnamese	{{Family name explanation|Ngô|Diệm|Ngo|lang=Vietnamese}}	In this article, the surname is Ngô, but is often simplified to Ngo in English-language text. In accordance with Vietnamese custom, this person should be referred to by the given name, Diệm.

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 explanation

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 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

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}}