Template:Hatnote

{{{1}}}

Template documentation

This template is used on 290,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please consider discussing any changes on the talk page before implementing them.

Usage

Using {{Hatnote|text}} formats text into the standard stylistic for a Wikipedia hatnote. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.

Function

This template is primarily used to add a correctly formatted hatnote to a page. Often, but not always, this is a disambiguation link at the top of article pages. It places an HTML div- / div block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.

This template is also used as the "meta-template" for additional specialized disambiguation link templates; see Wikipedia:Otheruses templates (example usage) for a list.

The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.

Code

<div class="dablink"></div>

Redirects

{{Dablink}}

Hatnote templates

Shortcut: T:HAT

For 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

{{Hatnote|CUSTOM TEXT}} →
CUSTOM TEXT

{{Hatnote|For other senses of this term, see [[etc…]]}} →

For other senses of this term, see etc…

{{Rellink|CUSTOM TEXT}} →
CUSTOM TEXT

Other uses of the same title

"This page is about … For other uses …"

{{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}} → Template:About
{{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) → Template:About
{{About|USE1|USE2|PAGE2}} (When there is only one other use) → Template:About
{{About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) → Template:About
{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}} (Using the {{!}} template to give the link a different title) → Template:About
{{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) → Template:About
{{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) → Template:About
{{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) →Template:About
{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}} → Template:About
{{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) → Template:About
{{About|||PAGE1|and|PAGE2}} → Template:About

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

{{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, see Hatnote (disambiguation).
{{For|OTHER TOPIC|PAGE1}} →
For OTHER TOPIC, see PAGE1.
{{For|OTHER TOPIC|PAGE1|PAGE2}} →
For OTHER TOPIC, see PAGE1 and PAGE2.
{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}} →
For OTHER TOPIC, see PAGE1, PAGE2, and PAGE3.
{{For||PAGE1|PAGE2}} →
For other uses, see PAGE1 and PAGE2.

Variations

As with {{Other uses}}, there are a whole family of "for" templates.

{{For2|OTHER TOPIC|CUSTOM TEXT}} → Template:For2

"For other uses, see …"

When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.

{{Other uses}} (disambiguous) → Template:Other uses
{{Other uses|PAGE1}} → Template:Other uses
{{Other uses|PAGE1|PAGE2}} → Template:Other uses

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:Other uses2

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

{{Other uses of}} (disambiguous) → Template:Other uses of
{{Other uses of|TOPIC}} (disambiguous) → Template:Other uses of
{{Other uses of|TOPIC|PAGE1}} → Template:Other uses of

"… redirects here. For other uses, see …"

{{Redirect|REDIRECT}} (disambiguous) → Template:Redirect
{{Redirect|REDIRECT||PAGE1}} → Template:Redirect
{{Redirect|REDIRECT|USE1|PAGE1}} → Template:Redirect
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}} → Template:Redirect
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → Template:Redirect
{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} → Template:Redirect
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} → Template:Redirect
{{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|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
- {{Redirect3|REDIRECT|TEXT}} → Template:Redirect3
- {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) → Template:Redirect4
For three sources:
- {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}} → Template:Redirect7
- {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}} (disambiguous) → Template:Redirect10

{{Redirect-synonym|TERM|OTHER TOPIC}} → Template:Redirect-synonym
{{Redirect text|REDIRECT|TEXT}} → Template:Redirect3

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

"… If you are seeking another topic, … consider adding it to …."

{{Consider disambiguation|USE1|USE2|PAGE2}} (disambiguous) → Template:Consider disambiguation
{{Consider disambiguation|USE1|USE2|PAGE2|PAGE3}} → Template:Consider disambiguation

Note:USE1 can be omitted, resulting in language like {{For}} above.

Similar proper names ("For other people named ...")

Other people

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

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

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

For articles on ships:

{{Other ships|SHIP1}} → Template:Other ships

Distinguish

"Not to be confused with …"

{{Distinguish|PAGE1}} → Template:Distinguish
{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}} → Template:Distinguish
{{Distinguish2|TEXT}} → Template:Distinguish2

"… redirects here. It is 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

Wikipedia self-reference

{{Selfref|ANYTEXT}} →
ANYTEXT

Further information: Wikipedia:Manual of Style/Self-references to avoid

Family names

Further information: Category:Hatnote templates for names

Lists

Further information: Category:Hatnote templates for lists

User pages

{{This user talk|TOPIC|PAGE1}} →

Template:This user talk

Notes

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