Template:Hatnote

Template documentation[view] [edit] [history] [purge]

This template formats text into the standard stylistic for a Wikipedia hatnote. It 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. Hatnotes look like this:

Example hatnote text.

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 Category:Hatnote templates 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.

Usage

Basic usage

{{hatnote|text}}

All parameters

{{hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}

Parameters

This template accepts the following parameters:

• 1 - the hatnote text. (required)
• extraclasses - any extra CSS classes to be added. For example, the {{see also}} template adds the classes |extraclasses=boilerplate seealso.
• selfref - if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.
• category - if set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the first positional parameter (the hatnote text) is omitted.

Example

• {{hatnote|Example hatnote text}} →
  Example hatnote text

Errors

If no hatnote text is supplied, the template will output the following message:

If you see this error message, it is for one of four reasons:

1. No parameters were specified (the template code was {{hatnote}}). Please use {{hatnote|text}} instead.
2. Some parameters were specified, but the hatnote text wasn't included. For example, the template text {{hatnote|extraclasses=seealso}} will produce this error. Please use (for example) {{hatnote|text|extraclasses=seealso}} instead.
3. The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code {{hatnote|2+2=4}} will produce this error. To work around this, you can specify the parameter name explictly by using 1= before the hatnote text, like this: {{hatnote|1=2+2=4}}.
4. You tried to access Module:Hatnote directly by using {{#invoke:hatnote|hatnote|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{hatnote|text}} instead.

If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.

Pages that contain this error message are tracked in Category:Hatnote templates with errors.

Technical details

The HTML code produced by this template looks like this:

• <div class="hatnote">hatnote text</div>

The code is produced by Module:Hatnote.

Hatnote templates

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…

More pages on the same topic ("Further information ...")

"Main article: …"

{{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 article: Main Article
• {{Main|Main Article|Article2}} →
  Main articles: Main Article and Article2
• {{Main list|Article1}} →
  For a more comprehensive list, see Article1.

"For more details on …, see …"

{{Details}} can supplement {{Main}} in summary sections, or can indicate more details in nonsummary sections:

• {{Details|PAGE1}} →

• {{Details|PAGE1|TOPIC}} →

{{Details3}} allows changing the displayed name for links. Unlike {{Details}}, it requires bracketed link notation:

• {{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}} →
  For more details on this topic, see NTSC Color encoding.
• {{Details3|[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]|TOPIC}} →
  For more details on TOPIC, see Article 1, Article 2, and Article 3.

Alternatively, the {{!}} magic word can be used to change the displayed name for links:

• {{Details|NTSC#Color_encoding{{!}}NTSC Color encoding}} →

"See also …"

• {{See also|TOPIC PAGE|OTHER TOPIC PAGE}} →

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}} →
  See also: OTHER TOPIC, OTHER TOPIC2, and OTHER TOPIC3 and other text

"Further information: …"

• {{Further|PAGE}} →
  Further information: PAGE
• {{Further|PAGE1|PAGE2}} →
  Further information: PAGE1, PAGE2, and PAGE3
• {{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}} →
  Further information: PAGE1, PAGE2, and PAGE3

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}} →
  This template is about USE1. For other uses, see Hatnote (disambiguation).
• {{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) →
  This template is about USE1. For other uses, see PAGE2.
• {{About|USE1|USE2}} (When there is only one other use) →
  This template is about USE1. For USE2, see PAGE2.
• {{About|USE1|USE2}} (Two pages for USE2) →
  This template is about USE1. For USE2, see PAGE2 and PAGE3.
• {{About|USE1|USE2}} (Using the {{!}} magic word to give the link a different title) →
  This template is about USE1. For USE2, see PAGE2TITLE.
• {{About|USE1|USE2}} (When there are up to four other uses – You should generally create a disambiguation page at this point) →
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For USE4, see PAGE4. For USE5, see PAGE5.
• {{About|USE1|USE2}} (When there are several standard other uses and also a disambiguation page with default name – Note that the last page name is not specified) →
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote (disambiguation).
• {{About|USE1|USE2}} (When there are several standard other uses and also a disambiguation page with non-default name) →
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see PAGE4.
• {{About|USE1|USE2}} →
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see PAGE4.
• {{About||USE2|PAGE2}} (When you don't need to state the focus of this article/page – Note the empty first parameter) →
  For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote (disambiguation).
• {{About|||PAGE1|and}} →
  For other uses, see PAGE1 and PAGE2.

Note: {{for||PAGE1|PAGE2}} produces the same result.

• {{About|USE1|section=yes}} →
  This section is about USE1. For other uses, see Hatnote (disambiguation).

Note: this hatnote says "section", instead of "article" or "page".

"This page is about … It is not to be confused with …"

{{About-distinguish}} is a template for noting other uses when there could be confusion with another topic.

• {{About-distinguish|USE1|PAGE1}} →
  This page is about USE1. It is not to be confused with PAGE1.
• {{About-distinguish2|USE1|TEXT}} →
  This page is about USE1. It is not to be confused with TEXT.

"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}} →
  For OTHER TOPIC, see PAGE1 and PAGE2.
• {{For|OTHER TOPIC|PAGE1}} →
  For OTHER TOPIC, see PAGE1, PAGE2, and PAGE3.
• {{For||PAGE1|PAGE2}} →

Variations

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

• {{For2|OTHER TOPIC|CUSTOM TEXT}} →
  For OTHER TOPIC, see CUSTOM TEXT.

"For other uses, see …"

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

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

Note: adds "(disambiguation)" to whatever is input as the PAGE1.

Note: {{Other uses|PAGE1 (disambiguation)}} produces the same result.

• {{Two other uses|USE1|USE2}} →
  This template is about USE1. For USE2, see PAGE2. For other uses, see Hatnote (disambiguation).

Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.

• {{Two other uses|USE1|USE2}} →
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3.
• {{Two other uses|USE2}} →
  For USE2, see PAGE2. For USE3, see PAGE3.
• {{Three other uses|USE1|USE2}}
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote (disambiguation).
• {{Three other uses||USE2|PAGE2}} →
  For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote (disambiguation).
• {{Three other uses|USE1|USE2}} →
  This template is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For USE4, see PAGE4.

"For other uses of …, see …"

• {{Other uses of}} (disambiguous) →
  For other uses of "Hatnote", see Hatnote (disambiguation).
• {{Other uses of|TOPIC}} (disambiguous) →
  For other uses of "TOPIC", see TOPIC (disambiguation).
• {{Other uses of|TOPIC|PAGE1}} →
  For other uses of "TOPIC", see PAGE1.

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

• {{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}} →
  "REDIRECT" redirects here. For USE1, see PAGE1.
• {{Redirect|REDIRECT|USE1}} →
  "REDIRECT" redirects here. For USE1, see PAGE1. For USE2, see PAGE2.
• {{Redirect|REDIRECT|USE1}} →
  "REDIRECT" redirects here. For USE1, see PAGE1. For USE2, see PAGE2. For USE3, see PAGE3.
• {{Redirect|REDIRECT|USE1}} →
  "REDIRECT" redirects here. For USE1, see PAGE1 and PAGE2.
• {{Redirect|REDIRECT|USE1}} →
  "REDIRECT" redirects here. For USE1, see PAGE1. For USE2, see PAGE2 and PAGE3.
• {{Redirect6|REDIRECT|USE1}} (disambiguous) →
  "REDIRECT" redirects here. For USE1, see PAGE1. For other uses, see REDIRECT (disambiguation).
• {{Redirect6|REDIRECT|USE1}} →
  "REDIRECT" redirects here. For USE1, see PAGE1. For other uses, see PAGE2.

Variations

• For two sources:
  • {{Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) →
    "REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation).
  • {{Redirect2|REDIRECT1|REDIRECT2}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For USE, see REDIRECT1 (disambiguation).
  • {{Redirect2|REDIRECT1|REDIRECT2||PAGE1}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For other uses, see PAGE1.
  • {{Redirect2|REDIRECT1|REDIRECT2}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For USE, see PAGE1.
  • {{Redirect2|REDIRECT1|REDIRECT2}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For USE1, see PAGE1. For USE2, see PAGE2.
  • {{Redirect2|REDIRECT1|REDIRECT2}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For USE1, see PAGE1. For USE2, see PAGE2. For USE3, see PAGE3.
  • {{Redirect2|REDIRECT1|REDIRECT2}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For USE1, see PAGE1. For USE2, see PAGE2. For USE3, see PAGE3. For USE4, see PAGE4.
  • {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) →
    "REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation) and REDIRECT2 (disambiguation).
  • {{Redirect4|REDIRECT1|REDIRECT2}} →
    "REDIRECT1" and "REDIRECT2" redirect here. For USE, see TEXT.
• For three sources:
  • {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1}} →
    "REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For USE1, see PAGE1. For USE2, see PAGE2.
  • {{Redirect10|REDIRECT1|REDIRECT2}} (disambiguous) →
    "REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For other uses, see REDIRECT1 (disambiguation), REDIRECT2 (disambiguation), and REDIRECT3 (disambiguation).
  • {{Redirect10|REDIRECT1|REDIRECT2}} →
    "REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For USE, see TEXT.
• To specify the text following "redirects here.":
  • {{Redirect3|REDIRECT|TEXT}} or {{Redirect text|REDIRECT|TEXT}} →
    "REDIRECT" redirects here. TEXT.
  • {{Redirect-synonym|TERM|OTHER TOPIC}} →
    "TERM" redirects here. TERM may also refer to OTHER TOPIC.

... Not to be confused with ...

• {{Redirect-distinguish|REDIRECT|PAGE1}} →
  "REDIRECT" redirects here. Not to be confused with PAGE1.
• {{Redirect-distinguish|REDIRECT|PAGE1}} →
  "REDIRECT" redirects here. Not to be confused with PAGE1, PAGE2, PAGE3, or PAGE4.
• {{Redirect-distinguish2|REDIRECT|TEXT}} →
  "REDIRECT" redirects here. It is not to be confused with TEXT.

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

Other people

• {{Other people}} (disambiguous) →
  For other people named Hatnote, see Hatnote (disambiguation).
• {{Other people|NAME}} (disambiguous) →
  For other people named NAME, see NAME (disambiguation).
• {{Other people|NAME|PAGE}} →
  For other people named NAME, see PAGE.
• {{Other people|NAME|PAGE}} →
  For other people titled NAME, see PAGE.
• {{Other people2|PAGE}} →
  For other people of the same name, see PAGE.
• {{Other people3}} (disambiguous) →
  For other people named Hatnote, see Hatnote (disambiguation).

Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used

• {{Other people3|PERSON1}} (disambiguous) →
  This article is about PERSON1. For other people named Hatnote, see Hatnote (disambiguation).
• {{Other people3|PERSON1|PERSON2}} (disambiguous) →
  This article is about PERSON1. For PERSON2, see Hatnote (disambiguation).
• {{Other people3|PERSON1|PERSON2}} →
  This article is about PERSON1. For PERSON2, see PAGE2.
• {{Other people3|PERSON1||PAGE2}} →
  This article is about PERSON1. For other people named Hatnote, see PAGE2.
• {{Other people5|NAME1|NAME2}} →
  For other people with similar names, see NAME1, NAME2, NAME3, or NAME4.

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) →
  For other places with the same name, see Hatnote (disambiguation).
• {{Other places|PAGE}}, analogous to {{Other uses2}}(disambiguous) →
  For other places with the same name, see PAGE (disambiguation).
• {{Other places3|PAGE}}, analogous to {{Other uses}} →
  For other places with the same name, see PAGE.

Other hurricanes

• {{Other hurricanes}} (disambiguous) →
  For other storms of the same name, see Hatnote (disambiguation).
• {{Other hurricanes|PAGE1}} →
  For other storms of the same name, see PAGE1.
• {{Other hurricanes|PAGE1|THIS}} →
  This template is about THIS. For other storms of the same name, see PAGE1.
• {{Other hurricanes||THIS}} →
  This template is about THIS. For other storms of the same name, see Hatnote (disambiguation).

Other ships

For articles on ships:

• {{Other ships|SHIP1}} →
  For other ships of the same name, see SHIP1.

Other popes named Stephen

• {{Pope Stephen ToP Dab|X}} →
  Note: In some sources, this pope is called Stephen XII and Pope Stephen X is called Stephen XI. See Pope-elect Stephen for detailed explanations.

Distinguish

"Not to be confused with …"

• {{Distinguish|PAGE1}} →
  Not to be confused with PAGE1.
• {{Distinguish|PAGE1|PAGE2}} →
  Not to be confused with PAGE1, PAGE2, PAGE3, or PAGE4.
• {{Distinguish2|TEXT}} →
  Not to be confused with TEXT.
• {{Distinct|PAGE1|PAGE2}} or {{Distinct|[[PAGE1]]|[[PAGE2]]|[[PAGE3]]|[[PAGE4]]}} →
  This topic is distinct from PAGE1, PAGE2, PAGE3, and PAGE4.
• {{Distinct|TEXT [[PAGE1]]}} →
  This topic is distinct from TEXT PAGE1.

"… redirects here. It is not to be confused with …"

• {{Redirect-distinguish|REDIRECT|PAGE1}} →
  "REDIRECT" redirects here. Not to be confused with PAGE1.
• {{Redirect-distinguish|REDIRECT|PAGE1}} →
  "REDIRECT" redirects here. Not to be confused with PAGE1, PAGE2, PAGE3, or PAGE4.
• {{Redirect-distinguish2|REDIRECT|TEXT}} →
  "REDIRECT" redirects here. It is not to be confused with TEXT.
  • Also may be used as {{Redirect-distinguish2|REDIRECT}} →
    "REDIRECT" redirects here.

"For technical reasons, … redirects here. For … , see … ."

• {{Technical reasons|REDIRECT}} →
  For technical reasons, "REDIRECT" redirects here.
• {{Technical reasons|REDIRECT|PAGE}} →
  For technical reasons, "REDIRECT" redirects here. For REDIRECT, see PAGE.
• {{Technical reasons|REDIRECT|DESCRIPTION}} →
  For technical reasons, "REDIRECT" redirects here. For DESCRIPTION, see PAGE.
• {{Technical reasons|REDIRECT|DESCRIPTION1}} →
  For technical reasons, "REDIRECT" redirects here. For DESCRIPTION1, see PAGE1. For DESCRIPTION2, see PAGE2.
• {{Technical reasons|REDIRECT|DESCRIPTION1}} →
  For technical reasons, "REDIRECT" redirects here. For DESCRIPTION1, see PAGE1. For DESCRIPTION2, see PAGE2. For DESCRIPTION3, see PAGE3.

Wikipedia self-reference

• {{Selfref|ANYTEXT}} →

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

Categories

Category-specific templates:

• {{Category see also|THIS|THAT}} →
  See also the categories THIS, THAT, and THE OTHER

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}} →
• {{Category explanation|colourless green ideas}} →
  This category is for colourless green ideas.
• {{Category pair|TOPIC1|TOPIC2}} →
  See also the preceding Category:TOPIC1 and the succeeding Category:TOPIC2.
• {{CatPreceding|OTHER TOPIC}} →
  See also the preceding Category:OTHER TOPIC.
• {{CatSucceeding|OTHER TOPIC}} →
  See also the succeeding Category:OTHER TOPIC.
• {{Contrast|OTHERCAT|OTHERCAT2}} →
  Hatnote is often contrasted with OTHERCAT or OTHERCAT2.
• {{Contrast|OTHERCAT|OTHERCAT2}} →
  Hatnote are often contrasted with OTHERCAT or OTHERCAT2.

Family names

Further information: Category:Hatnote templates for names

Lists

Further information: Category:Hatnote templates for lists

User pages

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

This is a Wikipedia user talk page. For other uses of TOPIC, see PAGE1.

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Hatnote in articles based on its TemplateData.

TemplateData for Hatnote

Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Text	1	This field should contain the text that will be displayed in the hatnote.	String	required
Extra classes	extraclasses	Extra CSS classes to be added to the <div> tags surrounding the hatnote text.	Line	optional
Self reference	selfref	Set to "yes" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. "For the Wikipedia Sandbox, see [[WP:SAND]]".)	Line	optional
Category	category	Set to "no", "n", "false", or "0" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted.	Unknown	optional

The above documentation is transcluded from Template:Hatnote/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.