Template:Hatnote/doc
![]() |
This is a documentation subpage for Template:Hatnote (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Usage[edit source]
Using {{Hatnote{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} 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.
Usage and purpose[edit source]
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.
Template contents[edit source]
<div class="dablink"></div>
![]() |
This is a documentation subpage for Template:Hatnote (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Generic[edit source]
- {{Dablink{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → TEXT
- {{Dablink{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → For other senses of this term, see etc...
- {{Rellink{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → TEXT
Other uses[edit source]
"This page is about ... For other uses ..."[edit source]
{{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{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → This page is about USE1. For other uses, see Hatnote/doc (disambiguation).
- {{About{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (When the disambiguation page has a different name — Note the empty second parameter) → This page is about USE1. For other uses, see PAGE2.
- {{About{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (When there is only one other use) → This page is about USE1. For USE2, see PAGE2.
- {{About{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (Two pages for USE2) →
- {{About{{{11}}}...}} (When there are up to five other uses — You should generally create a disambiguation page at this point) →
- {{About{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (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 page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote/doc (disambiguation).
- {{About{{{9}}}{{{10}}}{{{11}}}...}} (When there are several standard other uses and also a disambiguation page with non-default name) →
- {{About{{{10}}}{{{11}}}...}} → This page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see PAGE4 and Hatnote/doc (disambiguation).
- {{About{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (When you don't need to state the focus of this article/page — Note the empty first parameter) →
- {{About{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Note: {{for{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} produces the same result.
- {{This{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Note: {{About{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} produces the same result: → This page is about USE. For other uses, see Hatnote/doc (disambiguation).
- {{This{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Note: {{About{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (with one empty parameter) produces the same result: → This page is about USE. For other uses, see PAGE1.
- {{Other uses-section{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- Note: this hatnote says "section", instead of "article" or "page".
"For other uses, see ..."[edit source]
When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
- {{Other uses{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) → For other uses, see Hatnote/doc (disambiguation).
- {{Other uses{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → For other uses, see PAGE1.
- 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{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note: {{Other uses{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} produces the same result.
- {{Two other uses{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.
- {{Two other uses{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- tlx Three other uses USE1 USE2 PAGE2 USE3 PAGE3 Three other uses USE1 USE2 PAGE2 USE3 PAGE3
- tlx Three other uses||USE2|PAGE2|USE3|PAGE3 → Three other uses USE2 PAGE2 USE3 PAGE3
- tlx Three other uses USE1 USE2 PAGE2 USE3 PAGE3 USE4 PAGE4 → Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4
"For ..., see ..."[edit source]
{{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{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} is the same as {{About{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (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{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) → For OTHER TOPIC, see Hatnote/doc (disambiguation).
- {{For{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → For OTHER TOPIC, see PAGE1.
- {{For{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{For{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{For{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Variations
As with {{Other uses}}, there are a whole family of "for" templates.
- tlx For2 OTHER TOPIC CUSTOM TEXT → For2 OTHER TOPIC CUSTOM TEXT
- {{For example{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
"For other uses of ..., see ..."[edit source]
- {{Other uses of{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other uses of{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other uses of{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
"For more details on ..., see ..."[edit source]
{{Details{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} is used to make summary style explicit. To be used in a section for which there is also a separate article on the subject.
- {{Details{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- For more details on TOPIC, see Article.
{{Details3}} allows any text to links:
- {{Details3{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
"Further information: ..."[edit source]
- {{See{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → Further information: OTHER TOPIC
Example with multiple parameters
- {{See{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → Further information: Iraq and weapons of mass destruction,Saddam Hussein and al-Qaeda,Downing Street memo,andBush-Blair memo
- {{Further{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
This template takes a single parameter of any length.
"See also ..."[edit source]
- {{See also{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → See also: OTHER TOPIC
- Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.
- {{See also2{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
"... redirects here. For other uses, see ..."[edit source]
- {{Redirect{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Redirect{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect{{{9}}}{{{10}}}{{{11}}}...}} →
- Variations
- {{Redirect-acronym{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect2{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Redirect2{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect2{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect2{{{10}}}{{{11}}}...}} →
- {{Redirect3{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect4{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Redirect6{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Redirect7{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Note: If the number of pages redirecting to the target page is two, {{Redirect2{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} can be used instead. If the number is three and there are three corresponding disambiguation pages, {{Redirect10{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} can be used.
- {{Redirect10{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
Other people[edit source]
- {{Other persons{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other persons{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other persons{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- tlx Other people2 PAGE → Other people2 PAGE
- {{Other people3{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
- {{Other people3{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other people3{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other people3{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Other people3{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Other people4{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Other people5{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- Note: defaults to "named" as in {{Other persons}}, exists for options like "nicknamed", "known as", etc.
Other places[edit source]
- tlx Other places, analogous to tl Other uses (disambiguous) → otherplaces
- tlx|Other places|PAGE, analogous to tl|Other uses2 (disambiguous) → otherplaces PAGE
- tlx|Other places3|PAGE, analogous to tl|Other uses → otherplaces3 PAGE
Other hurricanes[edit source]
For articles on storms:
- {{Other hurricanes{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (disambiguous) →
- {{Other hurricanes{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Other hurricanes{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Other hurricanes{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
Other ships[edit source]
For articles on ships:
- {{Other ships{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
Distinguish[edit source]
"Not to be confused with ..."[edit source]
- {{tlx|Distinguish|PAGE1}} → {{Distinguish|PAGE1}}
- {{tlx|Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}} → {{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
- {{tlx|Distinguish2|TEXT}} → {{Distinguish2|TEXT}}
".. redirects here. It is not to be confused with ..."[edit source]
- {{Redirect-distinguish{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect-distinguish{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Redirect-distinguish2{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
"... is a common misspelling of ...[edit source]
- {{Misspelling{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
"Main article: ..." and more[edit source]
- {{Main{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → {{Main|Main Article}}
- {{Main{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → {{Main|Main Article|Article2}}
- {{tlx|Main list|Article1}} →
- {{Content fork{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{tlx|ArticlePreceeding|George Washington}} → {{ArticlePreceeding|George Washington}}
- {{tlx|ArticleSucceeding|Thomas Jefferson}} → {{ArticleSucceeding|Thomas Jefferson}}
- {{tlx|ArticlePair|George Washington|Thomas Jefferson}} → {{ArticlePair|George Washington|Thomas Jefferson}}
- {{Comprehensive{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
FamilySearch Wiki self-reference[edit source]
- {{Selfref{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} → ANYTEXT
- Note: used for hatnotes that don't make sense on mirrors of FamilySearch Wiki, such as linking an article from the main namespace to the FamilySearch Wiki namespace. (See: Manual of Style (self-references to avoid) for more details).
Categories[edit source]
Category-specific templates produce bold category names.
- {{Category see also{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Related category{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
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.
- {{CatPreceding{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{CatSucceeding{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Category pair{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Contrast{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} →
- {{Contrast2{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} (plural) →
Notes[edit source]
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 {{dablink}} instead? Before creating a new template, see: 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.