View source for Template:Family name explanation/doc

{{Documentation subpage}}
{{Template shortcut|fn{{#switch:{{ROOTPAGENAME}}|Family name hatnote=h|Family name footnote=f|Family name explanation=e}}}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use}}

'''{{NAMESPACE}}:{{ROOTPAGENAME}}''' is placed at the top of a biographical article to explain to readers which part of a name is the family name.
{{#switch:{{ROOTPAGENAME}}
|Family name footnote=It should go immediately after the bolded name, before the parenthetical. It requires that the article include {{t|notelist}} or, if {{para|reftype}} is used, another footnote template.
|Family name explanation=It is used by the [[WP:Wrapper|wrappers]] {{t|Family name footnote}} and {{t|Family name hatnote}}. More rarely, it may be invoked directly, e.g. for use within a larger footnote about a person's name.}}<!-- 
-->
== Usage ==
{| class="wikitable"
|+ 
|-
! scope="col" | Parameter
! scope="col" | Description
! scope="col" | Status
|-
! scope="row" | {{para|1}}
| The surname or family name of the subject.
| Required
|-
! scope="row" | {{para|2}}
| Triggers different text based on the language (see [[#Second_parameter|below]]). 
| Required for {{para|lang|Manchu}}; optional for others.
|-
! scope="row" | {{para|3}}
| For transliterated names or there are multiple name types.
| Optional
|-
! scope="row" | {{para|nd}}
| Use for Dutch names when a [[Maiden and married names|marital name]] is involved
| Conditional
|-
! scope="row" | {{para|lang}}
| The country or origin of the name; links to related articles if they exist.<br />{{Strong|Note}}: language names must be spelled out, not ISO codes, for example {{em|Spanish}} not {{em|es}}.
| Optional
|}

==Footnotes vs. hatnotes==
There is no universal consensus on whether to use footnotes or hatnotes for family name explanations.{{efn|See {{section link|Wikipedia:Village pump (proposals)/Archive 188|Method of surname clarification}}.}} However, never use both.{{efn|[[Special:Search/hastemplate:"family name footnote" hastemplate:"family name hatnote"|List of articles to fix]].}} For names that are clear to the average reader, such as [[Jeremy Lin]], use no explanation.

'''Hatnotes''' {{#ifeq:{{FULLPAGENAME}}|Template:Family name footnote|({{t|Family name hatnote}})}} 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 {{xtn|Foo Bar}} is one article and {{xtn|Bar Foo}} is another), or where a footnotes system would have to be introduced for the explanation.

'''Footnotes''' {{#ifeq:{{FULLPAGENAME}}|Template:Family name hatnote|({{t|Family name footnote}})}} are a newer, lower-emphasis method of name explanation introduced in 2020. Some editors argue that they better avoid giving [[WP:BALASP|undue prominence]] to name explanations. Others argue that they fit name explanations better as they do not muddle the navigational purpose of [[WP:Hatnotes|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 {{para|lang}} parameter will trigger a link to ''<lang> name'' (for example, [[Arabic name]]) if the page exists. Exceptions are listed below:

{| class="wikitable"
|+ 
|-
! scope="col" | Language
! scope="col" | Article
|-
! scope="row" | {{nowrap|Eastern Slavic}}
| [[Eastern Slavic naming customs]]
|-
! scope="row" | Hmong
| [[Hmong people]]
|-
! scope="row" | Ijebu
| [[Ijebu Kingdom]]
|-
! scope="row| Lebanese
| [[Lebanese Arabic]]
|-
! scope="row| Ottoman Turkish
| [[Ottoman Turkish]]
|-
! scope="row" | Romance
| [[Romance language]]
|-
! scope="row" | Toponymic
| third parameter is linked
|-
! scope="row" | 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.

{| class="wikitable"
|+ 
|-
! scope="col" | Language
! scope="col" | Code
! scope="col" | Example Output
|-
! scope="row" | No {{para|lang}} set
| {{tlx|{{ROOTPAGENAME}}|Simpson}}
| {{{{ROOTPAGENAME}}|Simpson}}
|-
! scope="row" | Burmese
| {{tlx|{{ROOTPAGENAME}}|Htang|lang{{=}}Burmese}}
| {{{{ROOTPAGENAME}}|Htang|lang=Burmese}}
|-
! scope="row" | Dutch
| {{tlx|{{ROOTPAGENAME}}|Van der Sar|lang{{=}}Dutch}}
| {{{{ROOTPAGENAME}}|Van der Sar|lang=Dutch}}
|-
! scope="row" | Ijebu
| {{tlx|{{ROOTPAGENAME}}|Àjàyí|lang{{=}}Ijebu}}
|{{{{ROOTPAGENAME}}|Àjàyí|lang=Ijebu}}
|-
! scope="row" | Mongolian
| {{tlx|{{ROOTPAGENAME}}|Tsedenbal|lang{{=}}Mongolian}}
| {{{{ROOTPAGENAME}}|Tsedenbal|lang=Mongolian}}
|-
! scope="row" | {{nowrap|Ottoman Turkish}}
| {{tlx|{{ROOTPAGENAME}}|Namık Kemal|lang{{=}}Ottoman Turkish}}
| {{{{ROOTPAGENAME}}|Namık Kemal|lang=Ottoman Turkish}}
|}

===Second parameter===
The second parameter triggers different wording depending on the language.
{| class="wikitable"
|+ 
|-
! scope="col" | Language
! scope="col" | Code
! scope="col" | Example Output
|-
! scope="row" | Argentine
| {{tlx|{{ROOTPAGENAME}}|Acosta|Benitez|lang{{=}}Argentine}}
| {{{{ROOTPAGENAME}}|Acosta|Benitez|lang=Argentine}}
|-
! scope="row" | Basque
| {{tlx|{{ROOTPAGENAME}}|Arana|Goiri|lang{{=}}Basque}}
| {{{{ROOTPAGENAME}}|Arana|Goiri|lang=Basque}}
|-
! scope="row" | Bulgarian
| {{tlx|{{ROOTPAGENAME}}|Ivanova|Georgieva-Kinova|lang{{=}}Bulgarian}}
| {{{{ROOTPAGENAME}}|Ivanova|Georgieva-Kinova|lang=Bulgarian}}
|-
! scope="row" | Cambodian{{efn|name=CHV|For Cambodian, Hmong, or Vietnamese, {{para|2}} is not required, and will still add the explanatory note.}}
| {{tlx|{{ROOTPAGENAME}}|Sok|Narvaratt|lang{{=}}Cambodian}}
| {{{{ROOTPAGENAME}}|Sok|Narvaratt|lang=Cambodian}}
|-
! scope="row" | Catalan
| {{tlx|{{ROOTPAGENAME}}|Miró|Ferrà|lang{{=}}Catalan}}
| {{{{ROOTPAGENAME}}|Miró|Ferrà|lang=Catalan}}
|-
! scope="row" | Chilean
| {{tlx|{{ROOTPAGENAME}}|Ocampo|Soto|lang{{=}}Chilean}}
| {{{{ROOTPAGENAME}}|Ocampo|Soto|lang=Chilean}}
|-
! scope="row" | Chinese
| {{tlx|{{ROOTPAGENAME}}|Wang|De|lang{{=}}Chinese}}
| {{{{ROOTPAGENAME}}|Wang|De|lang=Chinese}}
|-
! scope="row" | {{nowrap|Chinese Indonesian}}
| {{tlx|{{ROOTPAGENAME}}|[[Han (Chinese surname)|Han]]|Su|lang{{=}}Chinese Indonesian}}
| {{{{ROOTPAGENAME}}|[[Han (Chinese surname)|Han]]|Su|lang=Chinese Indonesian}}
|-
! scope="row" | Congolese
| {{tlx|{{ROOTPAGENAME}}|Tshisekedi|Tshilombo|lang{{=}}Congolese}}
| {{{{ROOTPAGENAME}}|Tshisekedi|Tshilombo|lang=Congolese}}
|-
! scope="row" | Dutch
| {{tlx|{{ROOTPAGENAME}}|Van der Sar|Sar|lang{{=}}Dutch}}
| {{{{ROOTPAGENAME}}|Van der Sar|Sar|lang=Dutch}}
|-
! scope="row" | Dutch (if {{para|nd|y}})
| {{tlx|{{ROOTPAGENAME}}|Noordewier|Reddingius|nd{{=}}yes|lang{{=}}Dutch}}
| {{{{ROOTPAGENAME}}|Noordewier|Reddingius|nd=yes|lang=Dutch}}
|-
! scope="row" | Eastern Slavic
| {{tlx|{{ROOTPAGENAME}}|Aleksandrovitch|Imyarek|lang{{=}}Eastern Slavic}}
| {{{{ROOTPAGENAME}}|Aleksandrovitch|Imyarek|lang=Eastern Slavic}}
|-
! scope="row" | Galician
| {{tlx|{{ROOTPAGENAME}}|Núñez|Castillo|lang{{=}}Galician}}
| {{{{ROOTPAGENAME}}|Núñez|Castillo|lang=Galician}}
|-
! scope="row" | German
| {{tlx|{{ROOTPAGENAME}}|Von Allmen|Allmen|lang{{=}}German}}
| {{{{ROOTPAGENAME}}|Von Allmen|Allmen|lang=German}}
|-
! scope="row" | Hmong{{efn|name=CHV}}
| {{tlx|{{ROOTPAGENAME}}|Kaying|Pha|lang{{=}}Hmong}}
| {{{{ROOTPAGENAME}}|Kaying|Pha|lang=Hmong}}
|-
! scope="row" | Korean
| {{tlx|{{ROOTPAGENAME}}|Lee|Han|lang{{=}}Korean}}
| {{{{ROOTPAGENAME}}|Lee|Han|lang=Korean}} 
|-
! scope="row" | Lebanese Arabic
| {{tlx|{{ROOTPAGENAME}}|Ali|Maatouk|lang{{=}}Lebanese}}
| {{{{ROOTPAGENAME}}|Ali|Maatouk|lang=Lebanese}} 
|-
! scope="row" | Manchu{{efn|The second parameter is required for this language}}
| {{tlx|{{ROOTPAGENAME}}|Oboi|Gūwalgiya|lang{{=}}Manchu}}
| {{{{ROOTPAGENAME}}|Oboi|Gūwalgiya|lang=Manchu}}
|-
! scope="row" | Medieval
| {{tlx|{{ROOTPAGENAME}}|Wolfram|von Eschenbach|lang{{=}}Medieval}}
| {{{{ROOTPAGENAME}}|Wolfram|von Eschenbach|lang=Medieval}}
|-
! scope="row" | Mongolian
| {{tlx|{{ROOTPAGENAME}}|Tsedenbal|Yumjaagiin|lang{{=}}Mongolian}}
| {{{{ROOTPAGENAME}}|Tsedenbal|Yumjaagiin|lang=Mongolian}}
|-
! scope="row" | ni-Vanuatu
| {{tlx|{{ROOTPAGENAME}}|Natapei|Rapi|lang{{=}}Ni-Vanuatu}}
| {{{{ROOTPAGENAME}}|Natapei|Rapi|lang=Ni-Vanuatu}}
|-
! scope="row" | Ottoman Turkish{{efn|For Ottoman Turkish, if {{para|3}} is given, the family name will be listed as well.}}
| {{tlx|{{ROOTPAGENAME}}|Osman Hamdi|Bey|lang{{=}}Ottoman Turkish}}
| {{{{ROOTPAGENAME}}|Osman Hamdi|Bey|lang=Ottoman Turkish}}
|-
! scope="row" | Romance
| {{tlx|{{ROOTPAGENAME}}|de Perier|Perier|lang{{=}}Romance}}
| {{{{ROOTPAGENAME}}|de Perier|Perier|lang=Romance}}
|-
! scope="row" | Slavic
| {{tlx|{{ROOTPAGENAME}}|Wołkowski|Wolkowski|lang{{=}}Slavic}}
| {{{{ROOTPAGENAME}}|Wołkowski|Wolkowski|lang=Slavic}}
|-
! scope="row" | Spanish
| {{tlx|{{ROOTPAGENAME}}|Gómez|Cruz|lang{{=}}Spanish}}
| {{{{ROOTPAGENAME}}|Gómez|Cruz|lang=Spanish}}
|-
! scope="row" | Turkic
| {{tlx|{{ROOTPAGENAME}}|Bölükbaşı|Bolukbasi|lang{{=}}Turkic}}
| {{{{ROOTPAGENAME}}|Bölükbaşı|Bolukbasi|lang=Turkic}}
|-
! scope="row" | Vietnamese{{efn|name=CHV}}{{efn|name=ThirdP|Vietnamese has a "transliterated" message similar to Slavic and Turkic, but is triggered by {{para|3}}.}}
| {{tlx|{{ROOTPAGENAME}}|Phan|Khải|lang{{=}}Vietnamese}}
| {{{{ROOTPAGENAME}}|Phan|Khải|lang=Vietnamese}}
|-
! scope="row" | All others <br/>({{em|A, not B}})
| {{tlx|{{ROOTPAGENAME}}|Wilson|Clark}}
| {{{{ROOTPAGENAME}}|Wilson|Clark}}
|}

===Third parameter===
With the exception of {{para|lang|Toponymic}}, the third parameter is used for transliterated names or a second name type.
{| class="wikitable"
|+ 
|-
! scope="col" | Language
! scope="col" | Code
! scope="col" | Example Output
|-
! scope="row" | Hong Kong{{efn|name="Chinesestyle"|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 {{code|Chan{{!}}Jackie Chan{{!}}Chan Kong-sang}}.}}
| {{tlx|{{ROOTPAGENAME}}|Chan|Jackie|Kong-sang|lang{{=}}Hong Kong}}
| {{{{ROOTPAGENAME}}|Chan|Jackie|Kong-sang|lang=Hong Kong}}
|-
! scope="row" | Macau{{efn|name="Chinesestyle"}}{{efn|Also works with the spelling Macao.}}
| {{txl|{{ROOTPAGENAME}}|Ho|Edmund|Hau Wah|lang{{=}}Macau}}
| {{{{ROOTPAGENAME}}|Ho|Edmund|Hau Wah|lang=Macau}}
|-
! scope="row" | Manchu
| {{tlx|{{ROOTPAGENAME}}|Hūlušun|Nara|Hulusun|lang{{=}}Manchu}}
| {{{{ROOTPAGENAME}}|Hūlušun|Nara|Hulusun|lang=Manchu}}
|-
! scope="row" | {{nowrap|Ottoman Turkish}}
| {{tlx|{{ROOTPAGENAME}}|Ali|Pasha|Çandarlı|lang{{=}}Ottoman Turkish}}
| {{{{ROOTPAGENAME}}|Ali|Pasha|Çandarlı|lang=Ottoman Turkish}}
|-
! scope="row" | {{nowrap|Ottoman Turkish}} <br />(if no title){{efn|For Ottoman Turkish, if {{para|2}} is left empty (note the double pipe, {{code|{{!}}{{!}}}}), "the title is..." section is not included.}}
| {{tlx|{{ROOTPAGENAME}}|Ali|{{!}}Çandarlı|lang{{=}}Ottoman Turkish}}
| {{{{ROOTPAGENAME}}|Ali||Çandarlı|lang=Ottoman Turkish}}
|-
! scope="row" | Toponymic
| {{tlx|{{ROOTPAGENAME}}|London|Edward|English name|lang{{=}}Toponymic}}
| {{{{ROOTPAGENAME}}|London|Edward|English name|lang=Toponymic}}
|-
! scope="row" | Vietnamese
| {{tlx|{{ROOTPAGENAME}}|Ngô|Diệm|Ngo|lang{{=}}Vietnamese}}
| {{{{ROOTPAGENAME}}|Ngô|Diệm|Ngo|lang=Vietnamese}}
|}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Surname or family name",
			"description": "The primary element in the person's surname",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Additional name element",
			"description": "Secondary element in the person's surname (depending upon language)",
			"type": "string",
			"suggested": true
		},
		"3": {
			"label": "Additional name element",
			"description": "Tertiary element in the person's surname or transliteration (depending upon language)",
			"type": "string",
			"suggested": true
		},
		"lang": {
			"label": "Language",
			"description": "Language or naming convention. Note: Spell out the language name; do not use ISO codes",
			"type": "string",
			"suggested": true,
			"example": "lang=Spanish (not lang=es)",
			"suggestedvalues": [
				"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"
			]
		},
		"nd": {
			"label": "Dutch marital name",
			"description": "Use only with Dutch surnames where the person's married name is to be specified",
			"type": "string",
			"suggested": true
		},
		"type": {
			"description": "Whether the explanation should be rendered as a footnote, a hatnote, or neither (default).",
			"type": "string",
			"suggestedvalues": [
				"footnote",
				"hatnote"
			],
			"default": "Neither",
			"label": "Explanation type"
		},
		"reftype": {
			"label": "Reference group type",
			"description": "Name of footnote template to use, such as efn, efn-lr, or NoteTag.",
			"type": "line",
			"default": "efn",
			"suggestedvalues": [
				"efn",
				"efn-lr",
				"efn-ua",
				"efn-ur",
				"efn-lg",
				"NoteTag"
			]
		}
	},
	"format": "inline",
	"description": "Placed at the top of a biographical article to explain to readers which part of a name is the family name."
}
</templatedata>

== Notes ==
{{Notelist}}

==Tracking categories==
* {{Category link with count|Pages using family name hatnote with no first parameter}}

==See also==
* [[WP:SUR]]
{{div col}}
* {{tl|Bhutanese name}}
* {{tl|British barrelled name}}
* {{tl|Dinka name}}
* {{tl|Ethiopian name}}
* {{tl|Fijian name}}
* {{tl|Given name hatnote}}
* {{tl|Icelandic name}}
* {{tl|Indian patronymic}}
* {{tl|Indonesian name}}
* {{tl|Malay name}}
* {{tl|Norse name}}
* {{tl|Patronymic name}}
* {{tl|Pakistani name}}
* {{tl|Philippine name}}
* {{tl|Portuguese name}}
* {{tl|Spanish colonial name}}
* {{tl|Spanish married name}}
* {{tl|Traditional Norwegian name}}
* {{tl|Western name order}} (primarily relevant to Hungarian names)
* {{tl|Western Slavic name}}
{{div col end}}

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
{{#switch:{{ROOTPAGENAME}}|Family name footnote=[[Category:Explanatory footnote name templates| ]]|Family name hatnote=[[Category:Hatnote templates for names| ]]|Family name explanation=[[Category:Name templates]]}}
}}</includeonly>