Template:Hatnote templates documentation
Contents
- 1 Hatnote templates
- 1.1 Generic hatnote
- 1.2 More pages on the same topic ("Further information ...")
- 1.3 Other uses of the same title ("For …, see …")
- 1.4 Similar proper names ("For other people named ...")
- 1.5 Distinguish
- 1.6 Family names
- 1.7 Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)
- 1.8 Categories
- 1.9 Lists
- 1.10 User pages
- 2 Notes
Hatnote templates
Hatnotes must be at the very top of the page or section.
Generic hatnote
{{Hatnote|CUSTOM TEXT}}
→CUSTOM TEXT
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}}
→Main article: Main Article{{Main|Main Article|Article2}}
→Main articles: Main Article and Article2{{Main list|Article1}}
→For a more comprehensive list, see Article1.
"For more details on …, see …"
{{Details}}
can supplement {{Main}}
in summary sections, or can indicate more details in nonsummary sections:
{{Details|PAGE1}}
→For more details on this topic, see PAGE1.{{Details|PAGE1|TOPIC}}
→For more details on TOPIC, see PAGE1.
{{Details3}}
allows changing the displayed name for links. Unlike {{Details}}
, it requires bracketed link notation:
{{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}}
→For more details on this topic, see NTSC Color encoding.{{Details3|[[article1|Article 1]], [[article2|Article 2]], and [[article3|Article 3]]|TOPIC}}
→
"See also …"
{{See also|TOPIC PAGE|OTHER TOPIC PAGE}}
→See also: TOPIC PAGE and OTHER TOPIC PAGE
- 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}}
→
"Further information: …"
{{Further|PAGE}}
→Further information: PAGE{{Further|PAGE1|PAGE2|PAGE3}}
→{{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}}
→
Other uses of the same title ("For …, see …")
"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}}
→This page is about USE1. For other uses, see Hatnote templates documentation (disambiguation).{{About|USE1||PAGE2}}
(When the disambiguation page has a different name – Note the empty second parameter) →This page is about USE1. For other uses, see PAGE2.{{About|USE1|USE2|PAGE2}}
(When there is only one other use) →This page is about USE1. For USE2, see PAGE2.{{About|USE1|USE2|PAGE2|and|PAGE3}}
(Two pages for USE2) →{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}
(Using the {{!}} magic word to give the link a different title) →This page is about USE1. For USE2, see PAGE2TITLE.{{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) →{{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) →This page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote templates documentation (disambiguation).{{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) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}
→This page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see PAGE4 and Hatnote templates documentation (disambiguation).{{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) →For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote templates documentation (disambiguation).{{About|||PAGE1|and|PAGE2}}
→
- Note:
{{for||PAGE1|PAGE2}}
produces the same result.
{{About|USE1|section=yes}}
→This section is about USE1. For other uses, see Hatnote templates documentation (disambiguation).
- 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.
{{About-distinguish|USE1|PAGE1}}
→This page is about USE1. It is not to be confused with PAGE1.{{About-distinguish2|USE1|TEXT}}
→This page is about USE1. It is not to be confused with TEXT.{{About-distinguish-custom|USE1|TEXT}}
→This page is about USE1. TEXT.
"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}}
→For OTHER TOPIC, see Hatnote templates documentation (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 is a whole family of "for" templates. {{For2}} allows custom text, such as quotation marks or a link from part of the "CUSTOM TEXT"
{{For2|OTHER TOPIC|CUSTOM TEXT}}
→For OTHER TOPIC, see CUSTOM TEXT.
"For other uses, see …"
When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
{{Other uses}}
→For other uses, see Hatnote templates documentation (disambiguation).{{Other uses|PAGE1}}
→For other uses, see PAGE1.{{Other uses|PAGE1|PAGE2}}
→
- 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}}
→For other uses, see PAGE1 (disambiguation).
- 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}}
→ Template: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}}
→ Template:Two other uses{{Two other uses||USE2|PAGE2|USE3|PAGE3}}
→ Template:Two other uses{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
This page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote templates documentation (disambiguation).{{Three other uses||USE2|PAGE2|USE3|PAGE3}}
→For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote templates documentation (disambiguation).{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→
"For other uses of …, see …"
{{Other uses of}}
→For other uses of "Hatnote templates documentation", see Hatnote templates documentation (disambiguation).{{Other uses of|TOPIC}}
→For other uses of "TOPIC", see TOPIC (disambiguation).{{Other uses of|TOPIC|PAGE1}}
→For other uses of "TOPIC", see PAGE1.
"… redirects here. For other uses, see …"
{{Redirect|REDIRECT}}
→"REDIRECT" redirects here. For other uses, see REDIRECT (disambiguation).{{Redirect|REDIRECT||PAGE1}}
→"REDIRECT" redirects here. For other uses, see PAGE1.{{Redirect|REDIRECT|USE1|PAGE1}}
→"REDIRECT" redirects here. For USE1, see 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}}
→{{Redirect6|REDIRECT|USE1|PAGE1}}
→"REDIRECT" redirects here. For USE1, see PAGE1. For other uses, see REDIRECT (disambiguation).{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
→
- Variations
- For two sources:
{{Redirect2|REDIRECT1|REDIRECT2}}
→"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation).{{Redirect2|REDIRECT1|REDIRECT2|USE}}
→"REDIRECT1" and "REDIRECT2" redirect here. For USE, see REDIRECT1 (disambiguation).{{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}
→"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see PAGE1.{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
→"REDIRECT1" and "REDIRECT2" redirect here. For USE, see PAGE1.{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→{{Redirect4|REDIRECT1|REDIRECT2}}
→"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation) and REDIRECT2 (disambiguation).{{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
→"REDIRECT1" and "REDIRECT2" redirect here. For USE, see TEXT.
- For three sources:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
→{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
→"REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For other uses, see REDIRECT1 (disambiguation), REDIRECT2 (disambiguation), and REDIRECT3 (disambiguation).{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}
→"REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For USE, see TEXT.
- To specify the text following "redirects here.":
{{Redirect3|REDIRECT|TEXT}}
or{{Redirect text|REDIRECT|TEXT}}
→"REDIRECT" redirects here. TEXT.{{Redirect-synonym|TERM|OTHER TOPIC}}
→"TERM" redirects here. TERM may also refer to OTHER TOPIC.
- ... Not to be confused with ...
{{Redirect-distinguish|REDIRECT|PAGE1}}
→"REDIRECT" redirects here. It is not to be confused with PAGE1.{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Redirect-distinguish2|REDIRECT|TEXT}}
→"REDIRECT" redirects here. It is not to be confused with TEXT.
Similar proper names ("For other people named ...")
Other people
{{Other people}}
→For other people named Hatnote templates documentation, see Hatnote templates documentation (disambiguation).{{Other people|NAME}}
→For other people named NAME, see NAME (disambiguation).{{Other people|NAME|PAGE}}
→For other people named NAME, see PAGE.{{Other people|NAME|PAGE|named=titled}}
→For other people titled NAME, see PAGE.{{Other people2|PAGE}}
→For other people of the same name, see PAGE.{{Other people3}}
→For other people named Hatnote templates documentation, see Hatnote templates documentation (disambiguation).
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}
→This article is about PERSON1. For other people named Hatnote templates documentation, see Hatnote templates documentation (disambiguation).{{Other people3|PERSON1|PERSON2}}
→This article is about PERSON1. For PERSON2, see Hatnote templates documentation (disambiguation).{{Other people3|PERSON1|PERSON2|PAGE2}}
→This article is about PERSON1. For PERSON2, see PAGE2.{{Other people3|PERSON1||PAGE2}}
→This article is about PERSON1. For other people named Hatnote templates documentation, see PAGE2.{{Other people5|NAME1|NAME2|NAME3|NAME4}}
→
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
{{Other places}}
, analogous to {{Other uses}} →For other places with the same name, see Hatnote templates documentation (disambiguation).{{Other places|PAGE}}
, analogous to {{Other uses2}} →For other places with the same name, see PAGE (disambiguation).{{Other places3|PAGE}}
, analogous to {{Other uses}} →For other places with the same name, see PAGE.
Other ships
For articles on ships:
{{Other ships|SHIP1}}
→For other ships of the same name, see SHIP1.
Distinguish
"Not to be confused with …"
{{Distinguish|PAGE1}}
→Not to be confused with PAGE1.{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Distinguish2|TEXT}}
→Not to be confused with TEXT.
"… redirects here. It is not to be confused with …"
{{Redirect-distinguish|REDIRECT|PAGE1}}
→"REDIRECT" redirects here. It is not to be confused with PAGE1.{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Redirect-distinguish2|REDIRECT|TEXT}}
→"REDIRECT" redirects here. It is not to be confused with TEXT.- Also may be used as
{{Redirect-distinguish2|REDIRECT}}
→"REDIRECT" redirects here.
- Also may be used as
"For technical reasons, … redirects here. For … , see … ."
{{Technical reasons|REDIRECT}}
→For technical reasons, "REDIRECT" redirects here.{{Technical reasons|REDIRECT|PAGE}}
→For technical reasons, "REDIRECT" redirects here. For REDIRECT, see PAGE.{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}
→For technical reasons, "REDIRECT" redirects here. For DESCRIPTION, see PAGE.{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}
→For technical reasons, "REDIRECT" redirects here. For DESCRIPTION1, see PAGE1. For DESCRIPTION2, see PAGE2.{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}
→For technical reasons, "REDIRECT" redirects here. For DESCRIPTION1, see PAGE1. For DESCRIPTION2, see PAGE2. For DESCRIPTION3, see PAGE3.
Family names
Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)
These hatnotes are topic-specific. They are documented at their template page.
{{Key people}}
{{Other hurricanes}}
{{Pope Stephen ToP Dab}}
{{Selfref}}
Categories
Category-specific templates:
{{Category see also|THIS|THAT|THE OTHER}}
→
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}}
→The main article for this category is MAIN ARTICLE.{{Category explanation|colourless green ideas}}
→This category is for colourless green ideas.{{Category pair|TOPIC1|TOPIC2}}
→See also the preceding Category:TOPIC1 and the succeeding Category:TOPIC2.{{CatPreceding|OTHER TOPIC}}
→See also the preceding Category:OTHER TOPIC.{{CatSucceeding|OTHER TOPIC}}
→See also the succeeding Category:OTHER TOPIC.{{Contrast|OTHERCAT|OTHERCAT2}}
→{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}
→
Lists
User pages
{{This user talk|TOPIC|PAGE1}}
→
Notes
32px | This template should not be substituted. Do not use subst: with these templates, as that will prevent:
|
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.
|
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. |