User:Sardanaphalus/Template:Hatnote templates documentation

.../ Template:Hatnote templates documentation

/Table

/tlp

Hatnote templates For the full guideline on hatnotes, see Wikipedia:Hatnote. As its name suggests, a hatnote is a brief message – usually no more than a single line – that is placed at the very top of a page or section. The line above ("For... see...") is an instance of the hatnote {{for}} and demonstrates hatnotes' default formatting: on a new line, left-indented and in italics. This is the formatting produced by the generic hatnote template {{hatnote}}: {{hatnote|Some text displayed as a generic hatnote.}}  produces: Some text displayed as a generic hatnote. Note:  For the sake of space, the hatnotes demonstrated in the following sections appear beside rather than below the code producing them.  Elsewhere, however, their formatting is usually as above. Links to disambiguation pages within hatnotes  ·  Key for examples below Links to disambiguation pages within hatnotes To indicate that a link in a hatnote to a disambiguation page is intentional, the link's label should include the suffix "(disambiguation)" even if the link itself is a redirect. For example, use {{other uses|Springfield (disambiguation)}} or {{other uses|Springfield (disambiguation)|Springfield}}, not {{other uses|Springfield}}. In the examples below "P" = Page name / article name / article title / etc; "text" = text that may include a link or links; "PAGENAME" = name of the page where the hatnote has been placed ({{PAGENAME}}).

Main article  ·  Further information  ·  See also {{main}} is generally used immediately after the heading to a section which summarizes a topic for which an article exists (or topics for which articles exist); see Wikipedia:Summary style. Code Output (normally on new line) {{main|(P1)}} Main article: (P1) {{main|(P1)|(P2)}} Main articles: (P1) and (P2) {{further|(P1)}} Further information: (P1) {{further|(P1)|(P2)|(P3)}} Further information: (P1), (P2), and (P3) {{further2|[text]}} Further information: [text] {{see also|(P1)}} See also: (P1) {{see also|(P1)|(P2)}} See also: (P1) and (P2) {{seealso2|[text]|[text2]|[text3]}} See also: [text1], [text2], and [text3] Note: When using a {{see also}} hatnote, only include a second (or further) page links when those pages [?contain a self-explanatory parenthetical] and their content is directly related and/or relevant.

About Note: When the following hatnotes appear in Wikipedia's main namespace – i.e. in articles – the word "page" is replaced by "article". Code Output (normally on new line) {{about|[use]}} This page is about [use]. For other uses, see PAGENAME (disambiguation). {{about|[use]||(P1)}} This page is about [use]. For other uses, see (P1). {{about|[use1]|[use2]|(P1)}} This page is about [use1]. For [use2], see (P1). {{about|[use1]|[use2]|(P1)|and|(P2)}} This page is about [use1]. For [use2], see (P1) and (P2). {{about|[use1]|[use2]|(P1)#(section)|(label)}} This page is about [use1]. For [use2], see (label). {{about|[use1]|[use2]|(P1)|[use3]|(P2)|other uses}} This page is about [use1]. For [use2], see (P1). For [use3], see (P2). For other uses, see PAGENAME (disambiguation). {{about|[use1]|[use2]|(P1)|[use3]|(P2)|other uses|(P3)}} This page is about [use1]. For [use2], see (P1). For [use3], see (P2). For other uses, see (P3). {{about|[use1]|[use2]|(P1)|[use3]|(P2)|other uses|(P3)|and}} This page is about [use1]. For [use2], see (P1). For [use3], see (P2). For other uses, see (P3) and PAGENAME (disambiguation). {{about|[use1]|[use2]|(P1)|[use3]|(P2)|[use4]|(P3)|[use5]|(P4)}} This page is about [use1]. For [use2], see (P1). For [use3], see (P2). For [use4], see (P3). For [use5], see (P4). Once a word or phrase has more than four other uses, a link to a disambiguation page is usually preferable to a hatnote or hatnotes. Code Output (normally on new line) When using {{about}} at the start of a section rather than a page, set |section=true (or on or y etc): {{about|section=true|[use1]}} This section is about [use1]. For other uses, see PAGENAME (disambiguation). The "about-distinguish" hatnotes include the "not to be confused with" phrasing that characterises the {{distinguish}}-style hatnotes (in the "Not to be confused with · Distinct from" section below): {{about-distinguish|[use]|(P1)}} This page is about [use]. It is not to be confused with (P1). {{about-distinguish2|[use]|[text]}} This page is about [use]. It is not to be confused with [text]. {{about}} can be used to generate {{for}}-like hatnotes (see "For" section below) because its second sentence begins "For ...". For example: {{about|||(P1)|and|(P2)}} For other uses, see (P1) and (P2). {{about||[use1]|(P1)|[use2]|(P2)|other uses}} For [use1], see (P1). For [use2], see (P2). For other uses, see PAGENAME (disambiguation). ... is about  [person] ... {{other people3|[person]}} This page is about [person]. For other people named other people named (PAGENAME), see PAGENAME (disambiguation). {{About other people|[person1]|[person2]}} This page is about [person1]. For other people named [person2], see PAGENAME (disambiguation). {{About other people|[person1]|[person2]|(P1)}} This page is about [person1]. For other people named [person2], see (P1). {{About other people|[person]||(P1)}} This page is about [person]. For other people named other people named (PAGENAME), see (P1). ... is about  [object/s] ... {{other hurricanes|(P1)|[text]}} This page is about [text]. For other storms of the same name, see (P1). {{other hurricanes ||[text]}} This page is about [text]. For other storms of the same name, see PAGENAME (disambiguation).

For {{for}} produces an {{about}}-like hatnote that omits an initial "This [page/article/etc] is about [use]." (This is the effect achieved by making {{about}}'s first parameter empty.) For example, {{for|(topic)|(P1)}} produces the same output as {{about ||(topic)|(P1)}}: For (topic), see (P1). Code Output (normally on new line) {{for|(other topic)}} For (other topic), see PAGENAME (disambiguation). {{for|(other topic)|(P1)}} For (other topic), see (P1). {{for|(other topic)|(P1)|(P2)}} For (other topic), see (P1) and (P2). {{for|(other topic)|(P1)|(P2)|(P3)}} For (other topic), see (P1), (P2), and (P3). {{for2|(other topic)|[text]}} For (other topic), see [[:[text]]]. For more ... Code Output (normally on new line) {{details|(P1)}} Further information: (P1) {{details|(P1)|topic=(P2)}} Further information on (P2): (P1) {{details}} can supplement {{main}} in summary sections, or, in other sections, can indicate more details. For a more ... Code Output (normally on new line) {{see introduction}} For a more accessible and less technical introduction to this topic, see Introduction to (PAGENAME). {{see introduction|(P1)}} For a more accessible and less technical introduction to this topic, see (P1). For the {{technical reasons}} hatnote ("For technical reasons, ... redirects here ..."), see the "redirects here" section below.

For other For other uses ... Code Output (normally on new line) {{other uses}} For other uses, see PAGENAME (disambiguation). {{other uses|(P1)}} For other uses, see (P1). {{other uses|(P1) (disambiguation)}} For other uses, see (P1) (disambiguation). {{otheruses2|(P1)}} {{otheruses2|(P1)}} {{other uses|(P1)|(P2)}} For other uses, see (P1) and (P2). {{for ||(P1)|(P2)}} For other uses of ... Code Output (normally on new line) {{other uses of}} For other uses of "(PAGENAME)", see PAGENAME (disambiguation). {{other uses of|(topic)}} For other uses of "(topic)", see (topic) (disambiguation). {{other uses of|(topic)|(P1)}} For other uses of "(topic)", see (P1). For other people ... Code Output (normally on new line) {{other people}} For other people named PAGENAME, see PAGENAME (disambiguation). {{other people|(name)}} For other people named (name), see (name) (disambiguation). {{other people|(name)|(P1)}} For other people named (name), see (P1). {{other people |named=titled|(name)|(P1)}} For other people titled (name), see (P1). {{other people2|(P1)}} For other people with the same name, see (P1). {{other people3}} For other people named PAGENAME, see PAGENAME (disambiguation). {{other people5|(W)|(P1)|(P2)|(P3)}} For other people with similar names, see (W), (P1), (P2), and (P3). For other places ... Code Output (normally on new line) {{other places}} For other places with the same name, see PAGENAME. {{other places|(P1)}} For other places with the same name, see (P1). {{otherplaces3|(P1)}} For other places with the same name, see (P1). For other [object]s ... Code Output (normally on new line) {{other hurricanes}} For other storms of the same name, see PAGENAME (disambiguation). {{other hurricanes|(P1)}} For other storms of the same name, see (P1). {{other ships|(P1)}} For other ships with the same name, see (P1).

redirects here Code Output (normally on new line) {{redirect|(topic)}} "(topic)" redirects here. For other uses, see (topic) (disambiguation). {{redirect|(topic) ||(P1)}} "(topic)" redirects here. For other uses, see (P1). {{redirect|(topic)|[use]|(P1)}} "(topic)" redirects here. For [use], see (P1). {{redirect|(topic)|[use1]|(P1)|[use2]|(P2)}} "(topic)" redirects here. For [use1], see (P1). For [use2], see (P2). {{redirect|(topic)|[use1]|(P1)|[use2]|(P2)|[use3]|(P3)}} "(topic)" redirects here. For [use1], see (P1). For [use2], see (P2). For [use3], see (P3). {{redirect|(topic)|[use]|(P1)|and|(P2)}} "(topic)" redirects here. For [use], see (P1) and (P2). {{redirect|(topic)|[use1]|(P1)|[use2]|(P2)|and|(P3)}} "(topic)" redirects here. For [use1], see (P1). For [use2], see (P2) and (P3). {{redirect3|(topic)|[text]}} "(topic)" redirects here. [text]. {{redirect text|(topic)|[text]}} "(topic)" redirects here. [text]. {{redirect-distinguish|(topic)|(P1)}} "(topic)" redirects here. Not to be confused with (P1). {{redirect-distinguish|(topic)|(W)|(P1)|(P2)|(P3)}} "(topic)" redirects here. Not to be confused with (W), (P1), (P2), or (P3). {{redirect-distinguish2|(topic)|[text]}} "(topic)" redirects here. Not to be confused with [text]. {{redirect-distinguish2|(topic)}} "(topic)" redirects here. {{redirect-synonym|(term)|(other topic)}} "(term)" redirects here. The term may also refer to (other topic). {{technical reasons|[text]}} {{technical reasons|[text]|(P1)}} {{technical reasons|[text]|(desc) |(P1)}} {{technical reasons|[text]|(desc1)|(P1)|(desc2)|(P2)}} {{technical reasons|[text]|(desc1)|(P1)|(desc2)|(P2)|(desc3)|(P3)}} ... redirect here ... Code Output (normally on new line) {{redirect2|(topic1)|(topic2)}} "(topic1)" and "(topic2)" redirect here. For other uses, see (topic1) (disambiguation). {{redirect2|(topic1)|(topic2)|[use]}} "(topic1)" and "(topic2)" redirect here. For [use], see (topic1) (disambiguation). {{redirect2|(topic1)|(topic2) ||(P1)}} "(topic1)" and "(topic2)" redirect here. For other uses, see (P1). {{redirect2|(topic1)|(topic2)|[use]|(P1)}} "(topic1)" and "(topic2)" redirect here. For [use], see (P1). {{redirect2|(topic1)|(topic2)|[use1]|(W)|[use2]|(P1)}} "(topic1)" and "(topic2)" redirect here. For [use1], see (W). For [use2], see (P1). {{redirect2|(topic1)|(topic2)|[use1]|(W)|[use2]|(P1)|[use3]|(P2)}} "(topic1)" and "(topic2)" redirect here. For [use1], see (W). For [use2], see (P1). For [use3], see (P2). {{redirect2|(topic1)|(topic2)|[use1]|(W)|[use2]|(P1)|[use3]|(P2)|[use4]|(P3)}} "(topic1)" and "(topic2)" redirect here. For [use1], see (W). For [use2], see (P1). For [use3], see (P2). For [use4], see (P3).

Not to be confused with  ·  distinct from Code Output (normally on new line) {{distinguish|(P1)}} Not to be confused with (P1). {{distinguish|(W)|(P1)|(P2)|(P3)}} Not to be confused with (W), (P1), (P2), or (P3). {{distinguish2|[text]}} Not to be confused with [text]. {{distinct|[[(W)]]|[[(P1)]]|[[(P2)]]|[[(P3)]]}} Not to be confused with [[:(W)]], [[:(P1)]], [[:(P2)]], or [[:(P3)]]. {{distinct|[text]}} Not to be confused with [[:[text]]].

<!-----------------------------------------------------------------------------
                                 This ... is
 ------------------------------------------------------------------------------>

{{Start hidden section
 |showhide=left |expanded={{#switch:{{{1|}}}|this=true}}
 |titlestyle=font-size:120%; |title=''This'' ... ''is'' ...
 |contentstyle=background:ghostwhite;font-size:105%;
}}

 [ {{introduction}} ]

{{End hidden section}}

===[Hatnotes by/for article/page type?]===
----
<!--------------------- Family names / Lists ------------------------>
{{Start hidden section
 |showhide=left |expanded={{#switch:{{{1|}}}|names|lists=true}}
 |titlestyle=font-size:120%; |title=For family names{{dot}}Lists
 |contentstyle=background:ghostwhite;font-size:105%;
}}
; {{big|Family names}}
{{see|:Category:Hatnote templates for names}}

; {{big|Lists}}
{{see|:Category:Hatnote templates for lists}}
{{/Table
 |class=nowrap |style=line-height:0.8em;overflow:auto;

 |colheaders=on
| {{/tlp|main list{{!}}(P1)}} | {{main list|(P1)}}
}}
{{End hidden section}}

<!--------------------- Category/user pages ------------------------->
{{Start hidden section
 |showhide=left |expanded={{#switch:{{{1|}}}|category|categories|user=true}}
 |titlestyle=font-size:120%; |title=For category or user pages
 |contentstyle=background:ghostwhite;font-size:105%;
}}
<!---col1width used: 25.0em--->
Hatnotes for use on [[Help:Category#Category pages|category pages]]:
{{/Table
 |col1width=25.0em

 |colheaders=on
| {{/tlp|category main{{!}}(P1)}} | {{category main|(P1)}}
 <!--[Rewrite/recast/exclude?:] [The following] is a template for linking categories ''horizontally''. Horizontal linkage is often the right solution when ''vertical linkage'' (i.e. as sub-category and parent category) is not appropriate. In most cases, this template should be used on ''both'' categories to create ''reciprocal linkage'' between the two categories.--> | {{/tlp|category see also{{!}}(P1)|(P2)|(P3)}} | {{category see also|(P1)|(P2)|(P3)}}
 | {{/tlp|category explanation{{!}}[text]}} | {{category explanation|[text]}}
 | {{/tlp|category pair{{!}}(P1)|(P2)}}   | {{category pair|(P1)|(P2)}}
 | {{/tlp|preceding category{{!}}(W)}}  | {{preceding category|(W)}}
 | {{/tlp|succeeding category{{!}}(P2)}} | {{succeeding category|(P2)}}
 | {{/tlp|contrast{{!}}(P1)|(P2)}}        | {{hatnote|(PAGENAME) is often contrasted with [[(P1)]] or [[(P2)]].}}
 | {{contrast|copula{{=}}are|(P1)|(P2)|}}    | {{hatnote|(PAGENAME) are often contrasted with [[(P1)]] or [[(P2)]].}}
}}

Hatnotes for use on [[Wikipedia:User pages|user pages]]:
{{/Table
 |col1width=25.0em
 | {{/tlp|this user talk{{!}}(topic)|(P1)}} | {{this user talk|(topic)|(P1)}}
}}
{{End hidden section}}

<!---------------------------- Other -------------------------------->
{{Start hidden section
 |showhide=left |expanded={{#switch:{{{1|}}}|other=true}}
 |titlestyle=font-size:120%; |title=Other hatnotes
 |contentstyle=background:ghostwhite;font-size:105%;
}}
<div>{{/tlp|Pope Stephen ToP Dab{{!}}X}} produces: {{Pope Stephen ToP Dab|X}}</div>
<div>{{/tlp|selfref{{!}}[text]}} produces: {{selfref|[text]}}</div>
For more information about self-referencing, see [[Wikipedia:Manual of Style/Self-references to avoid]].
{{End hidden section}}

===Hatnotes by template===
----
{{Start hidden section
 |showhide=left |expanded={{#switch:{{{1|}}}|by template|templates=true}}
 |titlestyle=font-size:120%; |title=Hatnotes by template
 |contentstyle=background:ghostwhite;font-size:105%;
}}
Note: "[text]" in the table below usually indicates a parameter that can include one or more links with or without labels ({{mono|[[Link|label]]}} or {{mono|[[Link]]}}).

{{/Table
 |cols=3 |class=nowrap |style=line-height:0.8em;overflow:auto;
 |col1style=padding-right:1.5em;
 |row1style=padding-bottom:0.5em;border-bottom:1px solid #aaa;
 | '''Template'''           | {{105%|'''Typical use...'''}} | {{nbsp|2}}'''...and output''' {{90%|(normally on new line)}}
 |row2style=padding-top:0.5em;
 | {{tlbare|about}}         | <nowiki>{{about|[use1]|[use2]|(P1)}} | {{about|[use1]|[use2]|(P1)}}
 | {{tlbare|about-distinguish}} | <nowiki>{{about-distinguish|[use1]|(P1)}} | {{about-distinguish|[use1]|(P1)}}
 | {{tlbare|about-distinguish2}} | <nowiki>{{about-distinguish2|[use1]|[text]}} | {{about-distinguish|[use1]|[text]}}
 | {{tlbare|category explanation}} | <nowiki>{{category explanation|[text]}} | {{category explanation|[text]}}
 | {{tlbare|category main}} | <nowiki>{{category main|(P1)}} | {{category main|(P1)}}
 | {{tlbare|category pair}} | <nowiki>{{category pair|(W)|(P2)}} | {{category pair|(W)|(P2)}}
 | {{tlbare|category see also}} | <nowiki>{{category see also|(P1)}} | {{category see also|(P1)}}
 | {{tlbare|contrast}}      | <nowiki>{{contrast|(P1)|(P2)}}  | {{hatnote|(PAGENAME) is often contrasted with [[(P1)]] or [[(P2)]].}}
 | {{tlbare|details}}       | <nowiki>{{details|(P1)}}       | {{details|(P1)}}
 | {{tlbare|distinct}}      | <nowiki>{{distinct|[text]}}   | {{distinct|[text]}}
 | {{tlbare|distinguish}}   | <nowiki>{{distinguish|(P1)}}   | {{distinguish|(P1)}}
 | {{tlbare|distinguish2}}  | <nowiki>{{distinguish|[text]}} | {{distinguish|[text]}}
 | {{tlbare|for}}           | <nowiki>{{for|(topic)|(P1)}}   | {{for|(topic)|(P1)}}
 | {{tlbare|for2}}          | <nowiki>{{for2|(topic)|[text]}} | {{for2|(topic)|[text]}}
 | {{tlbare|further}}       | <nowiki>{{further|(P1)}}       | {{further|(P1)}}
 | {{tlbare|further2}}      | <nowiki>{{further2|[text]}}   | {{further2|[text]}}
 | {{tlbare|hatnote}}       | <nowiki>{{hatnote|[text]}}    | {{hatnote|[text]}}
 | {{tlbare|main}}          | <nowiki>{{main|(P1)}}          | {{main|(P1)}}
 | {{tlbare|main list}}     | <nowiki>{{main list|(P1)}}     | {{main list|(P1)}}
 | {{tlbare|other hurricanes}} | <nowiki>{{other hurricanes|(P1)}} | {{other hurricanes|(P1)}}
 | {{tlbare|other people}}  | <nowiki>{{other people|(name)|(P1)}} | {{other people|(name)|(P1)}}
 | {{tlbare|otherpeople2}}  | <nowiki>{{subst:Otherpeople2|(P1)}}  | {{subst:Otherpeople2|(P1)}}
 | {{tlbare|otherpeople3}}  | <nowiki>{{otherpeople3|(name1)|(name2)|(P1)}} | {{otherpeople3|(name1)|(name2)|(P1)}}
 | {{tlbare|otherpeople5}}  | <nowiki>{{otherpeople5|(name1)|(name2)|(name3)|(name4)}} | {{otherpeople5|(name1)|(name2)|(name3)|(name4)}}
 | {{tlbare|other places}}  | <nowiki>{{other places|(P1)}}  | {{other places|(P1)}}
 | {{tlbare|otherplaces3}}  | <nowiki>{{otherplaces3|(P1)}}  | {{otherplaces3|(P1)}}
 | {{tlbare|other ships}}   | <nowiki>{{other ships|(P1)}}   | {{other ships|(P1)}}
 | {{tlbare|other uses}}    | <nowiki>{{other uses|(P1)}}    | {{other uses|(P1)}}
 | {{tlbare|otheruses2}}    | <nowiki>{{otheruses2|(P1)}}    | {{otheruses2|(P1)}}
 | {{tlbare|other uses of}} | <nowiki>{{other uses of|(topic)}} | {{other uses of|(topic)}}
 | {{tlbare|preceding category}} | <nowiki>{{preceding category|(W)}} | {{preceding category|(W)}}
 | {{tlbare|redirect}}      | <nowiki>{{redirect|(term)|(P1)}} | {{redirect|(term)|(P1)}}
 | {{tlbare|redirect2}}     | <nowiki>{{redirect2|(term1)|(term2)|[use]|(P1)}} | {{redirect2|(term1)|(term2)|[use]|(P1)}}
 | {{tlbare|redirect3}}     | <nowiki>{{redirect3|(term)|[text]}} | {{redirect3|(term)|[text]}}
 | {{tlbare|redirect text}} | <nowiki>{{redirect text|(term)|[text]}} | {{redirect text|(term)|[text]}}
 | {{tlbare|redirect-synonym}} | <nowiki>{{redirect-synonym|(term)|(topic)}} | {{redirect-synonym|(term)|(topic)}}
 | {{tlbare|redirect-distinguish}} | <nowiki>{{redirect-distinguish|(term)|(P1)}} | {{redirect-distinguish|(term)|(P1)}}
 | {{tlbare|redirect-distinguish2}} | <nowiki>{{redirect-distinguish2|(term)|[text]}} | {{redirect-distinguish2|(term)|[text]}}
 | {{tlbare|see also}}      | <nowiki>{{see also|(P1)}}      | {{see also|(P1)}}
 | {{tlbare|seealso2}}      | <nowiki>{{seealso2|[text]}}   | {{seealso2|[text]}}
 | {{tlbare|selfref}}       | <nowiki>{{selfref|[text]}}    | {{selfref|[text]}}
 | {{tlbare|succeeding category}} | <nowiki>{{succeeding category|(P2)}} | {{succeeding category|(P2)}}
 | {{tlbare|technical reasons}} | <nowiki>{{technical reasons|(term)|[text]|(P1)}} | {{technical reasons|(term)|[text]|(P1)}}
 | {{tlbare|this user talk}} | <nowiki>{{this user talk|(topic)|(P1)}} | {{this user talk|(topic)|(P1)}}
}}<!--(end Aligned table)-->
{{End hidden section}}

Notes

---

These templates are used in thousands of articles; therefore, changing the syntax could break thousands of articles. If you wish to create or edit a disambiguation or redirection template, first ask yourself the following questions:

1. Is there already a template that will do this job? Since many disambiguation and redirection templates have already been created, first check: Category:Disambiguation and redirection templates.
2. Do I really need a new template for this? Will it likely be used on any other articles or should I just use {{Hatnote}} instead? Before creating a new template, see the template namespace guideline.
3. If I change the parameters around on an existing template, do I know what the result will be? Will it break existing uses of the template and if so, can I fix all of the errors? Before making any changes, see Template sandbox and test cases.

See also

---

• Wikipedia:Disambiguation
• Wikipedia:Hatnote
• Category:Hatnote templates
• {{Shortcut}}

Documentation[create] [purge]

Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this page.

Formerly at very start of page:

{{navbar |style=float:right;background:transparent;padding:0 1.0em; |text=This overview: |Hatnote templates documentation}}
{{#switch:{{{toc|}}}
 |omit |off |no |false = __NOTOC__
 | {{#if:{{{toclimit<includeonly>|</includeonly>}}} |{{TOC limit|{{{toclimit}}}}} }}
}}