Template:Hatnote templates documentation
Hatnote templates
badloFor a summary page on how to use these templates, see the example page here. For the full editing guideline on hatnotes, see Wikipedia:Hatnote.
Generic
badlo{{Hatnote|CUSTOM TEXT}}→
{{Hatnote|For other senses of this term, see [[etc…]]}}→
More pages on the same topic ("Further information ...")
badlo"Main article: …"
badlo{{Main}} is used to make summary style explicit, when used in a summary section for which there is also a separate article on the subject:
{{Main|Main Article}}→
{{Main|Main Article|Article2}}→
{{Main list|Article1}}→
"For more details on …, see …"
badlo{{Details}} can supplement {{Main}} in summary sections, or can indicate more details in nonsummary sections:
{{Details|PAGE1}}→ Lua error in Module:Details at line 30: attempt to call field '_formatLink' (a nil value).
{{Details|PAGE1|TOPIC}}→ Lua error in Module:Details at line 30: attempt to call field '_formatLink' (a nil value).
{{Details3}} allows any text to links:
{{Details3|[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]|TOPIC}}→ Template:Details3
"See also …"
badlo{{See also|TOPIC PAGE|OTHER TOPIC PAGE}}→ Lua error in Module:See_also at line 43: attempt to call field 'formatPageTables' (a nil value).
- Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.
{{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}→ Template:See also2
"Further information: …"
badlo{{Further|PAGE}}→ Template:Further{{Further|PAGE1|PAGE2|PAGE3}}→ Template:Further{{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}}→ Template:Further2
Other uses of the same title
badlo"This page is about … For other uses …"
badlo{{About}} is the main template for noting other uses.
Note. When used in main namespace, the word "page" in the following hatnotes is replaced by "article".
{{About|USE1}}→ Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1||PAGE2}}(When the disambiguation page has a different name – Note the empty second parameter) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2}}(When there is only one other use) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2|and|PAGE3}}(Two pages for USE2) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}(Using the {{!}} template to give the link a different title) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}(When there are up to four other uses – You should generally create a disambiguation page at this point) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}(When there are several standard other uses and also a disambiguation page with default name – Note that the last page name is not specified) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4}}(When there are several standard other uses and also a disambiguation page with non-default name) →Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}→ Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About||USE2|PAGE2|USE3|PAGE3|other uses}}(When you don't need to state the focus of this article/page – Note the empty first parameter) → Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).{{About|||PAGE1|and|PAGE2}}→ Lua error in Module:Pagetype at line 175: attempt to call upvalue 'getPageObject' (a nil value).
- Note:
{{for||PAGE1|PAGE2}}produces the same result.
{{Other uses-section|USE}}(disambiguous) → Template:Other uses-section
- Note: this hatnote says "section", instead of "article" or "page".
"For …, see …"
badlo{{For}} can be used instead of {{About}} so as not to display: This page is about USE1. but still specify a specific other use. This effect can also be achieved by using an empty first parameter in {{About}} as in:
- For example:
{{for|OTHER TOPIC|PAGE1}}is the same as{{About||OTHER TOPIC|PAGE1}}(note the empty first parameter).
However, it is somewhat clearer when using the {{For}} template, since the word "about" does not appear in the statement.
{{For|OTHER TOPIC}}(disambiguous) →{{For|OTHER TOPIC|PAGE1}}→{{For|OTHER TOPIC|PAGE1|PAGE2}}→{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}→{{For||PAGE1|PAGE2}}→ Error: no context parameter provided. Use {{other uses}} for "other uses" hatnotes. (help).
- Variations
As with {{Other uses}}, there is a whole family of "for" templates.[clarification needed]
{{For2|OTHER TOPIC|CUSTOM TEXT}}→
"For other uses, see …"
badloWhen such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
{{Other uses}}(disambiguous) →{{Other uses|PAGE1}}→{{Other uses|PAGE1|PAGE2}}→
- Variations
There are, historically, a whole family of "other uses" templates for specific cases. {{About}} is the standard hatnote for "other uses" and many of them can be specified using the {{About}} template. However, the individual templates may be easier to use in certain contexts.
Here are the variations and (when appropriate) the equivalents using the {{About}}, {{Other uses}} or {{For}} templates.
{{Other uses2|PAGE1}}(disambiguous) → Template:Template for discussion/dated
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note:
{{Other uses|PAGE1 (disambiguation)}}produces the same result.
{{Two other uses|USE1|USE2|PAGE2}}→ Template:Two other uses
- Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.
{{Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}}→ Template:Two other uses{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}Template:Three other uses{{Three other uses||USE2|PAGE2|USE3|PAGE3}}→ Template:Three other uses{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}→ Template:Three other uses
"For other uses of …, see …"
badlo{{Other uses of}}(disambiguous) →{{Other uses of|TOPIC}}(disambiguous) →{{Other uses of|TOPIC|PAGE1}}→
"… redirects here. For other uses, see …"
badlo{{Redirect|REDIRECT}}(disambiguous) →"REDIRECT" redirects here. For other uses, see REDIRECT (disambiguation).{{Redirect|REDIRECT||PAGE1}}→"REDIRECT" redirects here. For other uses, see PAGE1.{{Redirect|REDIRECT|USE1|PAGE1}}→"REDIRECT" redirects here. For USE1, see PAGE1.{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}→{{Redirect6|REDIRECT|USE1|PAGE1}}(disambiguous) → Template:Redirect6{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}→ Template:Redirect6
- Variations
- For two sources:
{{Redirect2|REDIRECT1|REDIRECT2}}(disambiguous) → Template:Redirect2{{Redirect2|REDIRECT1|REDIRECT2|USE}}→ Template:Redirect2{{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}→ Template:Redirect2{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}→ Template:Redirect2{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}→ Template:Redirect2{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→ Template:Redirect2{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}→ Template:Redirect2{{Redirect4|REDIRECT1|REDIRECT2}}(disambiguous) → Template:Redirect4{{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}→ Template:Redirect4
- For three sources:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}→ Template:Redirect7{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}(disambiguous) → Template:Redirect10{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}→ Template:Redirect10
{{Redirect3|REDIRECT|TEXT}}or{{Redirect text|REDIRECT|TEXT}}→ Template:Redirect3{{Redirect-synonym|TERM|OTHER TOPIC}}→ Template:Redirect-synonym
- ... Not to be confused with ...
{{Redirect-distinguish|REDIRECT|PAGE1}}→ Template:Redirect-distinguish{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→ Template:Redirect-distinguish{{Redirect-distinguish2|REDIRECT|TEXT}}→ Template:Redirect-distinguish2
Similar proper names ("For other people named ...")
badloOther people
badlo{{Other people}}(disambiguous) → Template:Other people{{Other people|NAME}}(disambiguous) → Template:Other people{{Other people|NAME|PAGE}}→ Template:Other people{{Other people|NAME|PAGE|named=titled}}→ Template:Other people{{Other people2|PAGE}}→ Template:Other people2{{Other people3}}(disambiguous) → Template:Other people3
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}(disambiguous) → Template:Other people3{{Other people3|PERSON1|PERSON2}}(disambiguous) → Template:Other people3{{Other people3|PERSON1|PERSON2|PAGE2}}→ Template:Other people3{{Other people3|PERSON1||PAGE2}}→ Template:Other people3{{Other people5|NAME1|NAME2|NAME3|NAME4}}→ Template:Other people5
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
badlo{{Other places}}, analogous to {{Other uses}} (disambiguous) → Template:Other places{{Other places|PAGE}}, analogous to {{Other uses2}}(disambiguous) → Template:Other places{{Other places3|PAGE}}, analogous to {{Other uses}} → Template:Other places3
Other hurricanes
badlo{{Other hurricanes}}(disambiguous) → Template:Other hurricanes{{Other hurricanes|PAGE1}}→ Template:Other hurricanes{{Other hurricanes|PAGE1|THIS}}→ Template:Other hurricanes{{Other hurricanes||THIS}}→ Template:Other hurricanes
Other ships
badloFor articles on ships:
{{Other ships|SHIP1}}→ Template:Other ships
Other popes named Stephen
badloDistinguish
badlo"Not to be confused with …"
badlo{{Distinguish|PAGE1}}→{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Distinguish2|TEXT}}→
"… redirects here. It is not to be confused with …"
badlo{{Redirect-distinguish|REDIRECT|PAGE1}}→ Template:Redirect-distinguish{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→ Template:Redirect-distinguish{{Redirect-distinguish2|REDIRECT|TEXT}}→ Template:Redirect-distinguish2
"For technical reasons, … redirects here. For … , see … ."
badlo{{Technical reasons|REDIRECT}}→ Template:Technical reasons{{Technical reasons|REDIRECT|PAGE}}→ Template:Technical reasons{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}→ Template:Technical reasons{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}→ Template:Technical reasons{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}→ Template:Technical reasons
Wikipedia self-reference
badlo{{Selfref|ANYTEXT}}→
Categories
badloCategory-specific templates:
{{Category see also|THIS|THAT|THE OTHER}}→ Template:Category see also
This 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.
{{Cat main|MAIN ARTICLE}}→ Lua error in Module:Cat_main at line 26: attempt to call field 'formatPages' (a nil value).{{Category explanation|colourless green ideas}}→{{Category pair|TOPIC1|TOPIC2}}→ Template:Category pair{{CatPreceding|OTHER TOPIC}}→ Template:CatPreceding{{CatSucceeding|OTHER TOPIC}}→ Template:CatSucceeding{{Contrast|OTHERCAT|OTHERCAT2}}→ Template:Contrast{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}→ Template:Contrast
Family names
badloLists
badloUser pages
badlo{{This user talk|TOPIC|PAGE1}}→
Notes
badloDo not use subst: with these templates, as that will prevent:
- propagating changes as the template is modified; and the
- What links here (WLH) listing.
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:
- 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.
- 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.
- 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.
