Template:Hatnote/doc/Hatnote Templates Documentation View history

No edit summary
No edit summary
Line 18: Line 18:
* {{tlx|Details|PAGE1|TOPIC}} → {{Details|PAGE1|TOPIC}}
* {{tlx|Details|PAGE1|TOPIC}} → {{Details|PAGE1|TOPIC}}


{{tlx|Details3}} allows any text to links:
* {{tlx|Details3|<nowiki>[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]</nowiki>|TOPIC}} → {{Details3|[[Article 1]], [[Article 2]], and [[Article 3]]|TOPIC}}


===="''See also …''"====
===="''See also …''"====
Line 26: Line 24:


* {{tlx|See also2|<nowiki>[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text</nowiki>}} → {{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}
* {{tlx|See also2|<nowiki>[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text</nowiki>}} → {{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}
===="''Further information: …''"====
* {{tlx|Further|PAGE}} → {{Further|PAGE}}
* {{tlx|Further|PAGE1|PAGE2|PAGE3}} &rarr; {{Further|PAGE1|PAGE2|PAGE3}}
* {{tlx|Further2|<nowiki>[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]</nowiki>}} → {{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE3]]}}


===Other uses of the same title===
===Other uses of the same title===
Line 50: Line 43:
* {{tlx|About|<nowiki>|</nowiki>USE2|PAGE2|USE3|PAGE3|other uses}} (When you don't need to state the focus of this article/page – Note the empty first parameter) → {{About||USE2|PAGE2|USE3|PAGE3|other uses}}
* {{tlx|About|<nowiki>|</nowiki>USE2|PAGE2|USE3|PAGE3|other uses}} (When you don't need to state the focus of this article/page – Note the empty first parameter) → {{About||USE2|PAGE2|USE3|PAGE3|other uses}}
* {{tlx|About|<nowiki>||</nowiki>PAGE1|and|PAGE2}} → {{About|||PAGE1|and|PAGE2|_nocat=1}}
* {{tlx|About|<nowiki>||</nowiki>PAGE1|and|PAGE2}} → {{About|||PAGE1|and|PAGE2|_nocat=1}}
:Note: {{tlx|for|<nowiki>|</nowiki>PAGE1|PAGE2}} produces the same result.
* {{tlx|Other uses-section|USE}} (disambiguous) → {{Other uses-section|USE}}
* {{tlx|Other uses-section|USE}} (disambiguous) → {{Other uses-section|USE}}
:Note: this hatnote says "section", instead of "article" or "page".
:Note: this hatnote says "section", instead of "article" or "page".


===="''For …, see …''"====
{{tl|For}} can be used instead of {{tl|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 {{tl|About}} as in:
:''For example'': {{tlx|for|OTHER TOPIC|PAGE1}} is the same as {{tlx|About|<nowiki>|</nowiki>OTHER TOPIC|PAGE1}} (note the empty first parameter).<br>
However, it is somewhat clearer when using the {{tl|For}} template, since the word "about" does not appear in the statement.
* {{tlx|For|OTHER TOPIC}} (disambiguous) → {{For|OTHER TOPIC}}
* {{tlx|For|OTHER TOPIC|PAGE1}} → {{For|OTHER TOPIC|PAGE1}}
* {{tlx|For|OTHER TOPIC|PAGE1|PAGE2}} → {{For|OTHER TOPIC|PAGE1|PAGE2}}
* {{tlx|For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}} → {{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}
* {{tlx|For|<nowiki>|</nowiki>PAGE1|PAGE2}} → {{For||PAGE1|PAGE2}}
;Variations
As with {{tl|Other uses}}, there is a whole family of "for" templates.{{clarify|date=March 2013}}
* {{tlx|For2|OTHER TOPIC|CUSTOM TEXT}} → {{For2|OTHER TOPIC|CUSTOM TEXT}}


===="''For other uses, see …''"====
===="''For other uses, see …''"====
Line 80: Line 57:
There are, historically, a whole family of "other uses" templates for specific cases. {{tl|About}} is the standard hatnote for "other uses" and many of them can be specified using the {{tl|About}} template. However, the individual templates may be easier to use in certain contexts.
There are, historically, a whole family of "other uses" templates for specific cases. {{tl|About}} is the standard hatnote for "other uses" and many of them can be specified using the {{tl|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 {{tl|About}}, {{tl|Other uses}} or {{tl|For}} templates.
* {{tlx|Other uses2|PAGE1}} (disambiguous) → {{Other uses2|PAGE1}}
:Note: adds "(disambiguation)" to whatever is input as the PAGE1.
:Note: {{tlx|Other uses|PAGE1 (disambiguation)}} produces the same result.
* {{tlx|Two other uses|USE1|USE2|PAGE2}} → {{Two other uses|USE1|USE2|PAGE2}}
:Note: same as {{tl|about}}, except it forces a second use to be noted if unspecified by parameters.
* {{tlx|Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}} → {{Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
* {{tlx|Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}} {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
* {{tlx|Three other uses|<nowiki>|</nowiki>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 other uses of …, see …''"====
* {{tlx|Other uses of}} (disambiguous) → {{Other uses of}}
* {{tlx|Other uses of|TOPIC}} (disambiguous) → {{Other uses of|TOPIC}}
* {{tlx|Other uses of|TOPIC|PAGE1}} → {{Other uses of|TOPIC|PAGE1}}
===="''… redirects here. For other uses, see …''"====
* {{tlx|Redirect|REDIRECT}} (disambiguous) → {{Redirect|REDIRECT}}
* {{tlx|Redirect|REDIRECT<nowiki>||</nowiki>PAGE1}} → {{Redirect|REDIRECT||PAGE1}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1}} → {{Redirect|REDIRECT|USE1|PAGE1}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}} → {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} → {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} → {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
* {{tlx|Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) → {{Redirect6|REDIRECT|USE1|PAGE1}}
* {{tlx|Redirect6|REDIRECT|USE1|PAGE1&#124;|PAGE2}} → {{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
;Variations
* For two sources:
** {{tlx|Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) → {{Redirect2|REDIRECT1|REDIRECT2}}
** {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE}} → {{Redirect2|REDIRECT1|REDIRECT2|USE}}
** {{tlx|Redirect2|REDIRECT1|REDIRECT2<nowiki>||PAGE1</nowiki>}} → {{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}
** {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}} → {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
** {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}} → {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
** {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
** {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}} → {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
** {{tlx|Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) → {{Redirect4|REDIRECT1|REDIRECT2}}
** {{tlx|Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}} → {{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
* For three sources:
** {{tlx|Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}} → {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
** {{tlx|Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}} (disambiguous) → {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
** {{tlx|Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}} → {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}
* {{tlx|Redirect3|REDIRECT|TEXT}} or {{tlx|Redirect text|REDIRECT|TEXT}} → {{Redirect3|REDIRECT|TEXT}}
* {{tlx|Redirect-synonym|TERM|OTHER TOPIC}} → {{Redirect-synonym|TERM|OTHER TOPIC}}
;''... Not to be confused with ...''
* {{tlx|Redirect-distinguish|REDIRECT|PAGE1}} → {{Redirect-distinguish|REDIRECT|PAGE1}}
* {{tlx|Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}} → {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
* {{tlx|Redirect-distinguish2|REDIRECT|TEXT}} → {{Redirect-distinguish2|REDIRECT|TEXT}}
===Similar proper names ("''For other people named ...''")===
====Other people====
* {{tlx|Other people}} (disambiguous) → {{Other people}}
* {{tlx|Other people|NAME}} (disambiguous) → {{Other people|NAME}}
* {{tlx|Other people|NAME|PAGE}} → {{Other people|NAME|PAGE}}
* {{tlx|Other people|NAME|PAGE|named{{=}}titled}} → {{Other people|NAME|PAGE|named=titled}}
* {{tlx|Other people2|PAGE}} → {{Other people2|PAGE}}
* {{tlx|Other people3}} (disambiguous) → {{Other people3}}
:Note: same as {{tl|About}} except uses "other people" instead of "other uses" if only 1 parameter is used
* {{tlx|Other people3|PERSON1}} (disambiguous) → {{Other people3|PERSON1}}
* {{tlx|Other people3|PERSON1|PERSON2}} (disambiguous) → {{Other people3|PERSON1|PERSON2}}
* {{tlx|Other people3|PERSON1|PERSON2|PAGE2}} → {{Other people3|PERSON1|PERSON2|PAGE2}}
* {{tlx|Other people3|PERSON1<nowiki>||</nowiki>PAGE2}} → {{Other people3|PERSON1||PAGE2}}
* {{tlx|Other people5|NAME1|NAME2|NAME3|NAME4}} → {{Other people5|NAME1|NAME2|NAME3|NAME4}}
:Note: defaults to "named" as in {{tl|Other people}}, exists for options like "nicknamed", "known as", etc.
====Other places====
* {{tlx|Other places}}, analogous to {{tl|Other uses}} (disambiguous) → {{Other places}}
* {{tlx|Other places|PAGE}}, analogous to {{tl|Other uses2}}(disambiguous) → {{Other places|PAGE}}
* {{tlx|Other places3|PAGE}}, analogous to {{tl|Other uses}} → {{Other places3|PAGE}}
====Other hurricanes====
* {{tlx|Other hurricanes}} (disambiguous) → {{Other hurricanes}}
* {{tlx|Other hurricanes|PAGE1}} → {{Other hurricanes|PAGE1}}
* {{tlx|Other hurricanes|PAGE1|THIS}} → {{Other hurricanes|PAGE1|THIS}}
* {{tlx|Other hurricanes|<nowiki>|</nowiki>THIS}} → {{Other hurricanes||THIS}}
====Other ships====
For articles on ships:
* {{tlx|Other ships|SHIP1}} → {{Other ships|SHIP1}}
====Other popes named Stephen====
* {{tlx|Pope Stephen ToP Dab|X}} → {{Pope Stephen ToP Dab|X}}
===Distinguish===
===="''… redirects here. It is not to be confused with …''"====
* {{tlx|Redirect-distinguish|REDIRECT|PAGE1}} → {{Redirect-distinguish|REDIRECT|PAGE1}}
* {{tlx|Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}} → {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
* {{tlx|Redirect-distinguish2|REDIRECT|TEXT}} → {{Redirect-distinguish2|REDIRECT|TEXT}}
===="''For technical reasons, … redirects here. For … , see … .''"====
* {{tlx|Technical reasons|REDIRECT}} → {{Technical reasons|REDIRECT}}
* {{tlx|Technical reasons|REDIRECT|PAGE}} → {{Technical reasons|REDIRECT|PAGE}}
* {{tlx|Technical reasons|REDIRECT|DESCRIPTION|PAGE}} → {{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}
* {{tlx|Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}} → {{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}
* {{tlx|Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}} → {{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}
===Wikipedia self-reference===
* {{tlx|Selfref|ANYTEXT}} → {{Selfref|ANYTEXT}}
{{see|Wikipedia:Manual of Style/Self-references to avoid}}


===Family names===
===Family names===
Line 207: Line 80:
==See also==
==See also==
*[[Wikipedia:Hatnote]]
*[[Wikipedia:Hatnote]]
*{{cl|Hatnote templates}}
*{{tl|Shortcut}}
*{{tl|Shortcut}}


{{Navbox hatnote templates|state=collapsed}}<noinclude>
<noinclude>


{{Documentation}} <!-- so this is for the /doc page of this documentation-template -->
{{Documentation}} <!-- so this is for the /doc page of this documentation-template -->

Revision as of 15:36, 31 March 2015

Hatnote templates

Overview of hatnote templates: view · talk · 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

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

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

"For more details on …, see …"

{{Details}} can indicate more details in nonsummary sections:

For more details on this topic, see PAGE1.
For more details on TOPIC, see PAGE1.


"See also …"

Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.

Other uses of the same title

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

Note: this hatnote says "section", instead of "article" or "page".


"For other uses, see …"

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.


Family names

Template:See

Lists

Template:See

User pages

Template:This user talk

Notes

Do not use subst: with these templates, as that will prevent:

  1. propagating changes as the template is modified; and the
  2. 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:

  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


Documentation icon Template documentation[create]
Please add categories to the /doc subpage.
Subpages of this template.