Templat:Hatnote/doc
Templat:Strong for Templat:Terminate sentence It may contain usage information, categories and other content that is not part of the original templat page. |
This template is used on 290,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please consider discussing any changes on the talk page before implementing them. |
Usage
suntingUsing {{Hatnote|text 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.
Function
suntingThis 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.
Code
sunting<div class="dablink"></div>
Redirects
sunting- {{Dablink}}
Templat:Strong for Templat:Terminate sentence It may contain usage information, categories and other content that is not part of the original templat page. |
Hatnote templates
suntingFor 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
sunting- {{Hatnote|CUSTOM TEXT → CUSTOM TEXT
- {{Rellink|CUSTOM TEXT → CUSTOM TEXT
Other uses (of the title)
sunting"This page is about … For other uses …"
sunting{{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 → Templat:About
- {{About|USE1||PAGE2 (When the disambiguation page has a different name – Note the empty second parameter) → Templat:About
- {{About|USE1|USE2|PAGE2 (When there is only one other use) → Templat:About
- {{About|USE1|USE2|PAGE2|and|PAGE3 (Two pages for USE2) → Templat:About
- {{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE (Using the {{!}} template to give the link a different title) → Templat:About
- {{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5 (When there are up to four other uses – You should generally create a disambiguation page at this point) → Templat: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) → Templat: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) →Templat:About
- {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and → Templat: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) → Templat:About
- {{About|||PAGE1|and|PAGE2 → Templat:About
- Note: {{for||PAGE1|PAGE2 produces the same result.
- {{Other uses-section|USE (disambiguous) → Templat:Other uses-section
- Note: this hatnote says "section", instead of "article" or "page".
"See also …"
sunting- {{See also|OTHER TOPIC|OTHER TOPIC2 → Templat:See also
- Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.
- {{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text → Templat:See also2
"For …, see …"
sunting{{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/doc (disambiguation).
- {{For|OTHER TOPIC|PAGE1 → For OTHER TOPIC, see PAGE1.
- {{For|OTHER TOPIC|PAGE1|PAGE2 →
- {{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3 →
- {{For||PAGE1|PAGE2 →
- Variations
As with {{Other uses}}, there are a whole family of "for" templates.
- {{For2|OTHER TOPIC|CUSTOM TEXT → Templat:For2
"For other uses, see …"
suntingWhen such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
- {{Other uses (disambiguous) → Templat:Other uses
- {{Other uses|PAGE1 → Templat:Other uses
- {{Other uses|PAGE1|PAGE2 → Templat:Other uses
- 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) → Templat:Other uses2
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note: {{Other uses|PAGE1 (disambiguation) produces the same result.
- {{Two other uses|USE1|USE2|PAGE2 → Templat:Two other uses
- 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 → Templat:Two other uses
- {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3 Templat:Three other uses
- {{Three other uses||USE2|PAGE2|USE3|PAGE3 → Templat:Three other uses
- {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4 → Templat:Three other uses
"For other uses of …, see …"
sunting- {{Other uses of (disambiguous) → Templat:Other uses of
- {{Other uses of|TOPIC (disambiguous) → Templat:Other uses of
- {{Other uses of|TOPIC|PAGE1 → Templat:Other uses of
"For more details on …, see …"
sunting{{Details can supplement {{Main in summary sections, or can indicate more details in nonsummary sections:
- {{Details|Article|TOPIC → Templat:Details
{{Details3}} allows any text to links:
- {{Details3|[[article 1]], [[article 2]], and [[article 3]]|TOPIC → Templat:Details3
"… redirects here. For other uses, see …"
sunting- {{Redirect|REDIRECT (disambiguous) → Templat:Redirect
- {{Redirect|REDIRECT||PAGE1 → Templat:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1 → Templat:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2 → Templat:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3 → Templat:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2 → Templat:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3 → Templat:Redirect
- Variations
- {{Redirect-synonym|TERM|OTHER TOPIC → Templat:Redirect-synonym
- {{Redirect2|REDIRECT1|REDIRECT2 (disambiguous) → Templat:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1 → Templat:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2 → Templat:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3 → Templat:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3 → Templat:Redirect2
- {{Redirect3|REDIRECT|TEXT → Templat:Redirect3
- {{Redirect4|REDIRECT1|REDIRECT2 (disambiguous) → Templat:Redirect4
- {{Redirect6|REDIRECT|USE1|PAGE1 (disambiguous) → Templat:Redirect6
- {{Redirect6|REDIRECT|USE1|PAGE1||PAGE2 → Templat:Redirect6
- {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2 → Templat:Redirect7
- 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) → Templat:Redirect10
- ... Not to be confused with ...
- {{Redirect-distinguish|REDIRECT|PAGE1 → Templat:Redirect-distinguish
- {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4 → Templat:Redirect-distinguish
- {{Redirect-distinguish2|REDIRECT|TEXT → Templat:Redirect-distinguish2
"Further information: …"
sunting- {{Further|PAGE → Templat:Further
- {{Further|PAGE1|PAGE2|PAGE3 → Templat:Further
- {{Further2|[[Article 1]], [[Article 2]], and [[Article Something#3|Article 3]] → Templat:Further2
"… If you are seeking another topic, … consider adding it to …."
sunting- {{Consider disambiguation|USE1|USE2|PAGE2 (disambiguous) → Templat:Consider disambiguation
- {{Consider disambiguation|USE1|USE2|PAGE2|PAGE3 → Templat:Consider disambiguation
- Note:USE1 can be omitted, resulting in language like {{For}} above.
Other people, places, etcetera
suntingOther people
sunting- {{Other people (disambiguous) → Templat:Other people
- {{Other people|NAME (disambiguous) → Templat:Other people
- {{Other people|NAME|PAGE → Templat:Other people
- {{Other people|NAME|PAGE|named=titled → Templat:Other people
- {{Other people2|PAGE → Templat:Other people2
- {{Other people3 (disambiguous) → Templat:Other people3
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
- {{Other people3|PERSON1 (disambiguous) → Templat:Other people3
- {{Other people3|PERSON1|PERSON2 (disambiguous) → Templat:Other people3
- {{Other people3|PERSON1|PERSON2|PAGE2 → Templat:Other people3
- {{Other people3|PERSON1||PAGE2 → Templat:Other people3
- {{Other people5|NAME1|NAME2|NAME3|NAME4 → Templat:Other people5
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
sunting- {{Other places, analogous to {{Other uses}} (disambiguous) → Templat:Other places
- {{Other places|PAGE, analogous to {{Other uses2}}(disambiguous) → Templat:Other places
- {{Other places3|PAGE, analogous to {{Other uses}} → Templat:Other places3
Other hurricanes
suntingFor articles on storms:
- {{Other hurricanes (disambiguous) → Templat:Other hurricanes
- {{Other hurricanes|PAGE1 → Templat:Other hurricanes
- {{Other hurricanes|PAGE1|THIS → Templat:Other hurricanes
- {{Other hurricanes||THIS → Templat:Other hurricanes
Other ships
suntingFor articles on ships:
- {{Other ships|SHIP1 → Templat:Other ships
Distinguish
sunting"Not to be confused with …"
sunting- {{Distinguish|PAGE1 → Not to be confused with PAGE1.
- {{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4 →
- {{Distinguish2|TEXT → Templat:Distinguish2
"… redirects here. It is not to be confused with …"
sunting- {{Redirect-distinguish|REDIRECT|PAGE1 → Templat:Redirect-distinguish
- {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4 → Templat:Redirect-distinguish
- {{Redirect-distinguish2|REDIRECT|TEXT → Templat:Redirect-distinguish2
"Main article: …" etc.
sunting{{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 → Templat:Main
- {{Main|Main Article|Article2 → Templat:Main
- {{Main list|Article1 → Templat:Mainlist
- {{Cat main|MAIN ARTICLE → Templat:Cat main
Wikipedia self-reference
sunting- {{Selfref|ANYTEXT → ANYTEXT
Categories
suntingCategory-specific templates:
- {{Category see also|THIS|THAT|THE OTHER → Templat:Category see also
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 → Templat:Cat main
- {{Category explanation|colourless green ideas → Templat:Category explanation
- {{Category pair|TOPIC1|TOPIC2 → Templat:Category pair
- {{CatPreceding|OTHER TOPIC → Templat:CatPreceding
- {{CatSucceeding|OTHER TOPIC → Templat:CatSucceeding
- {{Contrast|OTHERCAT|OTHERCAT2 →
- {{Contrast|OTHERCAT|OTHERCAT2|plural=yes →
Family names
suntingLists
suntingUser pages
sunting- {{This user talk|TOPIC|PAGE1 →
Notes
suntingDo 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 {{Hatnote}} instead? Before creating a new template, see the 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.