Jump to content

Template:Hatnote templates documentation

From Wikipedia!

Hatnote templates

[edit]

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

[edit]
  • {{Hatnote|CUSTOM TEXT}}
{{Hatnote|For other senses of this term, see [[etc…]]}}

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

[edit]

"Main article: …"

[edit]

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

"For more details on …, see …"

[edit]

{{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 changing the displayed name for links. Unlike {{Details}}, it requires bracketed link notation:

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

  • {{Details|NTSC#Color_encoding{{!}}NTSC Color encoding}}Lua error in Module:Details at line 30: attempt to call field '_formatLink' (a nil value).

"See also …"

[edit]
  • {{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.

"Further information: …"

[edit]

Other uses of the same title

[edit]

"This page is about … For other uses …"

[edit]

{{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}}
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) →
  • {{About|USE1|USE2}} (When there is only one other use) →
  • {{About|USE1|USE2}} (Two pages for USE2) →
  • {{About|USE1|USE2}} (Using the {{!}} magic word to give the link a different title) →
  • {{About|USE1|USE2}} (When there are up to four other uses – You should generally create a disambiguation page at this point) →
  • {{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) →
  • {{About|USE1|USE2}} (When there are several standard other uses and also a disambiguation page with non-default name) →
  • {{About|USE1|USE2}}
  • {{About||USE2|PAGE2}} (When you don't need to state the focus of this article/page – Note the empty first parameter) →
  • {{About|||PAGE1|and}}
Note: {{for||PAGE1|PAGE2}} produces the same result.
Note: this hatnote says "section", instead of "article" or "page".

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

[edit]

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

"For …, see …"

[edit]

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

Variations

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

  • {{For2|OTHER TOPIC|CUSTOM TEXT}}

"For other uses, see …"

[edit]

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

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.

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.

"For other uses of …, see …"

[edit]

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

[edit]
Variations
... Not to be confused with ...

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

[edit]

Other people

[edit]
Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.

Other places

[edit]

Other hurricanes

[edit]

Other ships

[edit]

For articles on ships:

Other popes named Stephen

[edit]

Distinguish

[edit]

"Not to be confused with …"

[edit]

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

[edit]

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

[edit]

Wikipedia self-reference

[edit]

Categories

[edit]

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.

Family names

[edit]

Lists

[edit]

User pages

[edit]

Notes

[edit]

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

[edit]