Template:Hatnote templates documentation

From Open Transactions
Revision as of 12:56, 27 July 2014 by Redrose64 (talk) ("Not to be confused with …": rm blank line: WP:LISTGAP)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.


  • {{Hatnote|CUSTOM TEXT}} → {{#invoke:Hatnote|hatnote}}
{{Hatnote|For other senses of this term, see [[etc…]]}} → {{#invoke:Hatnote|hatnote}}

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}} → {{#invoke:main|main}}
  • {{Main|Main Article|Article2}} → {{#invoke:main|main}}
  • {{Main list|Article1}} → {{#invoke:Hatnote|hatnote}}

"For more details on …, see …"

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

  • {{Details|PAGE1}} → {{#invoke:details|details}}
  • {{Details|PAGE1|TOPIC}} → {{#invoke:details|details}}

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

  • {{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}} → {{#invoke:Hatnote|hatnote}}
  • {{Details3|[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]|TOPIC}} → {{#invoke:Hatnote|hatnote}}

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

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

"See also …"

  • {{See also|TOPIC PAGE|OTHER TOPIC PAGE}} → {{#invoke:see also|seealso}}
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}} → {{#invoke:Hatnote|hatnote}}

"Further information: …"

  • {{Further|PAGE}} → {{#invoke:further|further}}
  • {{Further|PAGE1|PAGE2|PAGE3}} → {{#invoke:further|further}}
  • {{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}} → {{#invoke:Hatnote|hatnote}}

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}} → {{#invoke:Hatnote|hatnote}}
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) → {{#invoke:Hatnote|hatnote}}
  • {{About|USE1|USE2|PAGE2}} (When there is only one other use) → {{#invoke:Hatnote|hatnote}}
  • {{About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) → {{#invoke:Hatnote|hatnote}}
  • {{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}} (Using the {{!}} magic word to give the link a different title) → {{#invoke:Hatnote|hatnote}}
  • {{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) → {{#invoke:Hatnote|hatnote}}
  • {{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) → {{#invoke:Hatnote|hatnote}}
  • {{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) →{{#invoke:Hatnote|hatnote}}
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}} → {{#invoke:Hatnote|hatnote}}
  • {{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) → {{#invoke:Hatnote|hatnote}}
  • {{About|||PAGE1|and|PAGE2}} → {{#invoke:Hatnote|hatnote}}
Note: {{for||PAGE1|PAGE2}} produces the same result.
  • {{About|USE1|section=yes}} → {{#invoke:Hatnote|hatnote}}
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.

"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) → {{#invoke:Hatnote|hatnote}}
  • {{For|OTHER TOPIC|PAGE1}} → {{#invoke:Hatnote|hatnote}}
  • {{For|OTHER TOPIC|PAGE1|PAGE2}} → {{#invoke:Hatnote|hatnote}}
  • {{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}} → {{#invoke:Hatnote|hatnote}}
  • {{For||PAGE1|PAGE2}} → {{#invoke:Hatnote|hatnote}}

As with {{Other uses}}, there is a whole family of "for" templates.{{ safesubst:#invoke:Unsubst||$N=Clarify |date=__DATE__ |$B= {{#invoke:Category handler|main}}{{#invoke:Category handler|main}}[clarification needed] }}

  • {{For2|OTHER TOPIC|CUSTOM TEXT}} → {{#invoke:Hatnote|hatnote}}

"For other uses, see …"

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

  • {{Other uses}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other uses|PAGE1}} → {{#invoke:Hatnote|hatnote}}
  • {{Other uses|PAGE1|PAGE2}} → {{#invoke:Hatnote|hatnote}}

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) → {{#invoke:Hatnote|hatnote}}
Note: adds "(disambiguation)" to whatever is input as the PAGE1.
Note: {{Other uses|PAGE1 (disambiguation)}} produces the same result.
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}} → {{#invoke:Hatnote|hatnote}}
  • {{Two other uses|USE2|PAGE2|USE3|PAGE3}} → {{#invoke:Hatnote|hatnote}}
  • {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}} {{#invoke:Hatnote|hatnote}}
  • {{Three other uses||USE2|PAGE2|USE3|PAGE3}} → {{#invoke:Hatnote|hatnote}}
  • {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}} → {{#invoke:Hatnote|hatnote}}

"For other uses of …, see …"

  • {{Other uses of}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other uses of|TOPIC}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other uses of|TOPIC|PAGE1}} → {{#invoke:Hatnote|hatnote}}

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

  • {{Redirect|REDIRECT}} (disambiguous) → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect|REDIRECT||PAGE1}} → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect|REDIRECT|USE1|PAGE1}} → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}} → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} → {{#invoke:redirect hatnote|redirect}}
  • {{Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}} → {{#invoke:Hatnote|hatnote}}
  • For two sources:
    • {{Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
    • {{Redirect2|REDIRECT1|REDIRECT2|USE}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect2|REDIRECT1|REDIRECT2||PAGE1}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
    • {{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}} → {{#invoke:Hatnote|hatnote}}
  • For three sources:
    • {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}} → {{#invoke:Hatnote|hatnote}}
    • {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
    • {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}} → {{#invoke:Hatnote|hatnote}}
  • To specify the text following "redirects here.":
... Not to be confused with ...

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

Other people

  • {{Other people}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other people|NAME}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other people|NAME|PAGE}} → {{#invoke:Hatnote|hatnote}}
  • {{Other people|NAME|PAGE|named=titled}} → {{#invoke:Hatnote|hatnote}}
  • {{Other people2|PAGE}} → {{#invoke:Hatnote|hatnote}}
  • {{Other people3}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
  • {{Other people3|PERSON1}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other people3|PERSON1|PERSON2}} (disambiguous) → {{#invoke:Hatnote|hatnote}}
  • {{Other people3|PERSON1|PERSON2|PAGE2}} → {{#invoke:Hatnote|hatnote}}
  • {{Other people3|PERSON1||PAGE2}} → {{#invoke:Hatnote|hatnote}}
  • {{Other people5|NAME1|NAME2|NAME3|NAME4}} → {{#invoke:Hatnote|hatnote}}
Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.

Other places

Other hurricanes

Other ships

For articles on ships:

Other popes named Stephen


"Not to be confused with …"

  • {{Distinguish|PAGE1}} → {{#invoke:Hatnote|hatnote}}
  • {{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}} → {{#invoke:Hatnote|hatnote}}
  • {{Distinguish2|TEXT}} → {{#invoke:Hatnote|hatnote}}
  • {{Distinct|PAGE1|PAGE2|PAGE3|PAGE4}} or {{Distinct|[[PAGE1]]|[[PAGE2]]|[[PAGE3]]|[[PAGE4]]}} → {{#invoke:Hatnote|hatnote}}
  • {{Distinct|TEXT [[PAGE1]]}} → {{#invoke:Hatnote|hatnote}}

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

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

  • {{Technical reasons|REDIRECT}} → {{#invoke:Hatnote|hatnote}}
  • {{Technical reasons|REDIRECT|PAGE}} → {{#invoke:Hatnote|hatnote}}
  • {{Technical reasons|REDIRECT|DESCRIPTION|PAGE}} → {{#invoke:Hatnote|hatnote}}
  • {{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}} → {{#invoke:Hatnote|hatnote}}
  • {{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}} → {{#invoke:Hatnote|hatnote}}

Wikipedia self-reference

  • {{Selfref|ANYTEXT}} → {{#invoke:Hatnote|hatnote}}



Category-specific templates:

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}} → {{#invoke:Cat main|catMain}}
  • {{Category explanation|colourless green ideas}} → {{#invoke:Hatnote|hatnote}}
  • {{Category pair|TOPIC1|TOPIC2}} → {{#invoke:Hatnote|hatnote}}
  • {{CatPreceding|OTHER TOPIC}} → {{#invoke:Hatnote|hatnote}}
  • {{CatSucceeding|OTHER TOPIC}} → {{#invoke:Hatnote|hatnote}}
  • {{Contrast|OTHERCAT|OTHERCAT2}} → {{#invoke:Hatnote|hatnote}}
  • {{Contrast|OTHERCAT|OTHERCAT2|plural=yes}} → {{#invoke:Hatnote|hatnote}}

Family names




User pages



{{#invoke:Message box|ombox}}

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


{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}