View source for Template:Family name hatnote/doc

{{Documentation subpage}}
{{Template shortcut|fnh}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use}}

=== Usage ===
This template is put at the top of a biographical article to explain to readers which part of a name is the family name.

This template has one required parameter, and multiple optional parameters:
* {{para|1}}, required, the surname or family name of the subject.
* {{para|2}}, optional, triggers different text based on the language (see [[#Second_parameter|below]]). Required for {{para|lang|Manchu}}
* {{para|3}}, optional, for transliterated names or there are multiple name types
* {{para|nd}}, optional, use this parameter for Dutch names when a [[Maiden and married names|marital name]] is involved
* {{para|lang}}, optional, the country/origin of the name; links to related articles if they exist

==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"
|+ Caption text
|-
! scope="col" | Language
! scope="col" | Article
|-
! scope="row" | Hmong
| [[Hmong people]]
|-
! scope="row" | Ijebu
| [[Ijebu Kingdom]], [[Yoruba name]]
|-
! scope="row| Ottoman Turkish
| [[Ottoman Turkish language]]
|-
! scope="row" | Romance
| [[Romance languages]]
|-
! scope="row" | Telugu
| [[Telugu name]]
|-
! 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.
*{{tlx|Family name hatnote|Simpson}}: {{Family name hatnote|Simpson}}
*{{tlx|Family name hatnote|Van der Sar|lang{{=}}Dutch}}: {{Family name hatnote|Van der Sar|lang=Dutch}}
*{{tlx|Family name hatnote|Namık Kemal|lang{{=}}Ottoman Turkish}}: {{Family name hatnote|Namık Kemal|lang=Ottoman Turkish}}
*{{tlx|Family name hatnote|Example|lang{{=}}Burmese}}: {{Family name hatnote|Example|lang=Burmese}}

===Second parameter===
The second parameter triggers different wording depending on the language.
{| class="wikitable"
|+ 
|-
! scope="col" | Language
! scope="col" | Example Output
|-
! scope="row" | Argentine<br>Dutch (if {{para|nd|y}})
| {{Family name hatnote|Noordewier|Reddingius|nd=yes|lang=Dutch}}
|-
! scope="row" | Catalan
| {{family name hatnote|Miró|Ferrà|lang=Catalan}}
|-
! scope="row" | Congolese
| {{family name hatnote|Tshisekedi|Tshilombo|lang=Congolese}}
|-
! scope="row" | Spanish
| {{family name hatnote|Gómez|Cruz|lang=Spanish}}
|-
! scope="row" | Basque<br>Galician
| {{family name hatnote|Arana|Goiri|lang=Basque}}
|-
! scope="row" | Chinese<br>{{nowrap|Chinese Indonesian}}
| {{Family name hatnote|[[Han (Chinese surname)|Han]]|Su|lang=Chinese Indonesian}}
|-
! scope="row" | Dutch (no {{para|nd}})<br>Germanic<br>Romance
| {{Family name hatnote|Van der Sar|Sar|lang=Dutch}}
|-
! scope="row" | Korean
| {{family name hatnote|Lee|Han|lang=Korean}} 
|-
! scope="row" | Slavic<br>Turkic
| {{Family name hatnote|Wołkowski|Wolkowski|lang=Slavic}}
|-
! scope="row" | Cambodian{{efn|For Cambodian, Hmong, or Vietnamese, {{{2}}} is not required, and will still add the explanatory note.}}<br>Hmong<br>Vietnamese{{efn|name=ThirdP|Vietnamese has a "transliterated" message similar to Slavic/Turkic, but is triggered by {{{3}}}}}
| {{family name hatnote|Phan|Khải|lang=Vietnamese}}
|-
! scope="row" | Manchu{{efn|The second parameter is required for this language}}
| {{Family name hatnote|Oboi|Gūwalgiya|lang=Manchu}}
|-
! scope="row" | Ottoman Turkish{{efn|if {{{3}}} is given, the family name will be listed as well}}
| {{Family name hatnote|Osman Hamdi|Bey|lang=Ottoman Turkish}}
|-
! scope="row" | Mongolian{{efn|If no second parameter is given, will state that there is neither a patronymic nor family name}}
| {{family name hatnote|Tsedenbal|Yumjaagiin|lang=Mongolian}}
|-
! scope="row" | All others
| "A, not B": {{family name hatnote|Wilson|Clark}}
|}
{{notelist}}

===Third parameter===
With the exception of {{para|lang|Toponymic}}, the third parameter is used for transliterated names and/or a second name type
{| class="wikitable"
|+ 
|-
! scope="col" | Language
! scope="col" | Example Output
|-
! scope="row" | Toponymic
| {{Family name hatnote|London|Edward|English name|lang=Toponymic}}
|-
! scope="row" | {{nowrap|Ottoman Turkish}}{{efn|If {{{2}}} is not provided, "the title is..." section is not included}}
| {{Family name hatnote|Ali|Pasha|Çandarlızade|lang=Ottoman Turkish}}
|-
! scope="row" | Manchu<br>Vietnamese
| {{family name hatnote|Ngô|Diệm|Ngo|lang=Vietnamese}}
|}
{{notelist}}

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

==See also==
* [[WP:SUR]]

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Hatnote templates for names]]
}}</includeonly>