Template:Hatnote templates documentation
| This is a template documentation page. This page may not be intended to be viewed directly. Links using variables may appear broken; do not replace these with hardcoded page names or URLs. |
Contents
Otheruses templates
To discuss these templates as a whole, please see: Disambiguation (talk). If you wish to discuss general wordings, rather than the wording or formatting of this specific template, don't post here or else what you say will probably go unnoticed.
For a summary page on how to use these templates, see the example page here.
Generic
{{Dablink|TEXT}}
- For example:
{{dablink|For other senses of this term, see [[etc...]]}}. (Note: adaptable, but fails to standardize hatnotes).
{{Selfref|TEXT}}
- Note: similar in usage to the Dablink template, but used for hatnotes that don't make sense on mirrors of Wikipedia, such as linking an article from the main namespace to the Wikipedia namespace. (See: Avoid self-references for more details).
Other Uses
About
Note. When used in main namespace, the word "page" in the following hatnotes is replaced by "article".
{{about|USE1}}
Script error: No such module "about".
{{about|USE1||PAGE2}}(When the disambiguation page has a different name — Note the empty second parameter)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2}}(When there is only one other use)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2|and|PAGE3}}(Two pages for USE2)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}(When there are up to five other uses — You should generally create a disambiguation page at this point)
Script error: No such module "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)
Script error: No such module "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)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}
Script error: No such module "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)
Script error: No such module "about".
Otheruses
When such a wordy hatnote as {{about}} is not needed, {{otheruses}} is often useful.
{{otheruses}}(disambiguous)
{{otheruses|PAGE1}}
Variations
There are, historically, a whole family of "other uses" templates for specific cases. {{otheruses4}} has been generalized and merged with {{about}} to form the standard hatnote for "other uses" and many of the others 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}} {{otheruses}} or {{for}} templates.
{{otheruses2|PAGE1}}(disambiguous) Template:Otheruses2
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note:
{{otheruses|PAGE1 (disambiguation)}}produces the same result.
{{otheruses5}}(disambiguous) Template:Otheruses5
- Note: use when there is both a singular and plural disambiguation page. (Only works when the plural is formed by simply adding a "s" at the end)
{{otheruses6|PAGE1|PAGE2}}Template:Otheruses6
- Note: use when there are two disambiguation pages, such as a noun and an adjective or a singular and irregular plural. There are only two parameters, at least one parameter is required.
- Note:
{{for||PAGE1|PAGE2}}and{{about|||PAGE1|and|PAGE2}}produce the same result.
{{otheruses-section|USE}}(disambiguous) Template:Otheruses-section
- Note: same as {{about}}, except that it says "section", instead of "article" or "page".
For
{{for}} can be used instead of {{about}} so as not to display: This page is about USE1. but still specify as 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 empty first parameter).
However, it is somewhat more clear when using the {{for}} template, since the word "about" does not appear in the statement.
{{for|OTHER TOPIC}}(disambiguous){{for|OTHER TOPIC|PAGE1}}{{for|OTHER TOPIC|PAGE1|PAGE2}}{{for||PAGE1|PAGE2}}Error: no context parameter provided. Use {{other uses}} for "other uses" hatnotes. (help).
Variations
As with {{otheruses}}, there are a whole family of "for" templates. For example {{for3}} appends the word the in its mention of the second parameter, then generating a link, using either the second or (if present) the third parameter, as a parenthetical. Additionally, {{the}} is simply a rendering of {{for3}}, without bothering with the optional first argument.
{{for2|OTHER TOPIC|CUSTOM TEXT}}{{for3||DIFFERENT MEANING}}Template:For3{{for3|OTHER TOPIC|DIFFERENT MEANING}}Template:For3{{for3|OTHER TOPIC|DIFFERENT MEANING|CUSTOM PARENTHETICAL}}Template:For3{{the|DIFFERENT MEANING}}Template:The{{the|DIFFERENT MEANING|CUSTOM PARENTHETICAL}}Template:The
See also
{{see also|OTHER TOPIC}}
- Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.
Other people
{{otherpersons}}(disambiguous) Template:Otherpersons{{otherpersons|NAME}}(disambiguous) Template:Otherpersons{{otherpersons|NAME|PAGE}}Template:Otherpersons{{otherpersons3|NAME|PAGE|named=titled}}Template:Otherpersons3
- Note: defaults to "named" as in {{otherpersons}}, exists for options like "nicknamed", "known as", etc.
{{otherpeople2|PAGE}}Template:Otherpeople2{{otherpeople3}}(disambiguous) Template:Otherpeople3
- Note: same as {{otherpersons}} except uses "people" instead of "persons"
{{otherpeople3|PERSON1}}(disambiguous) Template:Otherpeople3{{otherpeople3|PERSON1|PERSON2}}(disambiguous) Template:Otherpeople3{{otherpeople3|PERSON1|PERSON2|PAGE2}}Template:Otherpeople3{{otherpeople3|PERSON1||PAGE2}}Template:Otherpeople3
Other places
{{otherplaces}}, analogous to{{otheruses}}(disambiguous)
{{otherplaces|PAGE}}, analogous to{{otheruses2}}(disambiguous)
{{otherplaces3|PAGE}}, analogous to{{otheruses}}
Otherhurricaneuses
For articles on storms:
{{otherhurricaneuses}}(disambiguous) Template:Otherhurricaneuses{{otherhurricaneuses|DISAMBIG}}Template:Otherhurricaneuses{{otherhurricaneuses|DISAMBIG|THIS}}Template:Otherhurricaneuses{{otherhurricaneuses||THIS}}Template:Otherhurricaneuses
Otherusesof (topic)
{{otherusesof}}(disambiguous) Template:Otherusesof{{otherusesof|TOPIC}}(disambiguous) Template:Otherusesof{{otherusesof|TOPIC|PAGE1}}Template:Otherusesof
Redirect
{{Redirect|REDIRECT}}(disambiguous)
{{Redirect|REDIRECT||PAGE1}}
{{Redirect|REDIRECT|USE1|PAGE1}}
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
Variations
{{Redirect-acronym|TERM|PAGE}}
{{Redirect2|REDIRECT1|REDIRECT2}}(disambiguous)
{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
{{Redirect3|REDIRECT|TEXT}}
{{Redirect4|REDIRECT1|REDIRECT2}}(disambiguous)
{{Redirect6|REDIRECT|USE1|PAGE1}}(disambiguous)
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
- Note: If the number of pages redirecting to the target page is two, {{Redirect2}} can be used instead. If the number is three and there are three corresponding disambiguation pages, {{Redirect10}} can be used.
{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}(disambiguous)
{{Redirect-distinguish|REDIRECT|PAGE}}
Homonyms and homophones: "Not to be confused with..."
{{Distinguish|PAGE1}}{{Distinguish2|TEXT}}Template:Distinguish2{{Redirect-distinguish|REDIRECT|PAGE}}
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.
Please do not edit these templates, unless you know what you are doing.
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 another template already, 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 test cases.
Initial visibility: currently defaults to autocollapse
To set this template's initial visibility, the |state= parameter may be used:
|state=collapsed:{{Hatnote templates documentation|state=collapsed}}to show the template collapsed, i.e., hidden apart from its title bar|state=expanded:{{Hatnote templates documentation|state=expanded}}to show the template expanded, i.e., fully visible|state=autocollapse:{{Hatnote templates documentation|state=autocollapse}}
If the |state= parameter in the template on this page is not set, the template's initial visibility is taken from the |default= parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse.
TemplateData for VisualEditor
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| State | state | no description | Unknown | optional |
See also
| The above documentation is transcluded from Template:Hatnote templates documentation/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |