Difference between revisions of "Module:Hatnote templates documentation"

From blackwiki
Jump to navigation Jump to search
m (630 revisions imported)
 
(252 intermediate revisions by 82 users not shown)
Line 1: Line 1:
{{documentation subpage}}<!-- Note this is a documentation page currently aimed at multiple (all?) hatnote templates. (January 2011).
+
#REDIRECT [[Template:Hatnote templates]]
--><div style="float:right; padding: 0 1em;">{{navbar|Hatnote templates documentation}}</div>
 
==Hatnote templates==
 
{{Shortcut|T:HAT}}
 
For a summary page on how to use these templates, see [[Wikipedia:HATTEST|the example page here]]. For the full editing guideline on hatnotes, see [[Wikipedia:Hatnote]].
 
  
===Generic===
+
{{Rcat shell|h=See also {{tl|Hatnote templates/doc}}.|
* {{tlx|Dablink|TEXT}} &rarr; {{Dablink|TEXT}}
+
{{R from merge|Wikipedia:Hatnote#Hatnote templates}}
:{{tlx|Dablink|For other senses of this term, see [[etc...]]}} &rarr; {{Dablink|For other senses of this term, see [[etc...]]}}
+
}}
* {{tlx|Rellink|TEXT}} &rarr; {{Rellink|TEXT}}
 
 
 
===Other uses===
 
===="This page is about ... For other uses ..."====
 
{{tl|About}} is the main template for noting other uses.
 
 
 
''Note. When used in [[Wikipedia:Main namespace|main namespace]], the word "page" in the following hatnotes is replaced by "article".''
 
 
 
* {{tlx|About|USE1}} &rarr; {{About|USE1}}
 
* {{tlx|About|USE1<nowiki>||</nowiki>PAGE2}} (When the disambiguation page has a different name — Note the empty second parameter) &rarr; {{About|USE1||PAGE2}}
 
* {{tlx|About|USE1|USE2|PAGE2}} (When there is only one other use) &rarr; {{About|USE1|USE2|PAGE2}}
 
* {{tlx|About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) &rarr; {{About|USE1|USE2|PAGE2|and|PAGE3}}
 
* {{tlx|About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} (When there are up to five other uses — You should generally create a [[Wikipedia:Disambiguation|disambiguation page]] at this point) &rarr; {{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}
 
* {{tlx|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) &rarr; {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}
 
* {{tlx|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) &rarr;{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4}}
 
* {{tlx|About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}} &rarr; {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}
 
* {{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) &rarr; {{About||USE2|PAGE2|USE3|PAGE3|other uses}}
 
* {{tlx|About|<nowiki>||</nowiki>PAGE1|and|PAGE2}} &rarr; {{About|||PAGE1|and|PAGE2|_nocat=1}}
 
:Note: {{tlx|for|<nowiki>|</nowiki>PAGE1|PAGE2}} produces the same result.
 
 
 
* {{tlx|Other uses-section|USE}} (disambiguous) &rarr; {{Other uses-section|USE}}
 
:Note: this hatnote says "section", instead of "article" or "page".
 
 
 
===="For other uses, see ..."====
 
When such a wordy hatnote as {{tl|About}} is not needed, {{tl|Other uses}} is often useful.
 
 
 
* {{tlx|Other uses}} (disambiguous) &rarr; {{Other uses}}
 
* {{tlx|Other uses|PAGE1}} &rarr; {{Other uses|PAGE1}}
 
 
 
;Variations
 
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) &rarr; {{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}} &rarr; {{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}} &rarr; {{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}} &rarr; {{Three other uses||USE2|PAGE2|USE3|PAGE3}}
 
* {{tlx|Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}} &rarr; {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
 
 
 
===="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) &rarr; {{For|OTHER TOPIC}}
 
* {{tlx|For|OTHER TOPIC|PAGE1}} &rarr; {{For|OTHER TOPIC|PAGE1}}
 
* {{tlx|For|OTHER TOPIC|PAGE1|PAGE2}} &rarr; {{For|OTHER TOPIC|PAGE1|PAGE2}}
 
* {{tlx|For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}} &rarr; {{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}
 
* {{tlx|For|<nowiki>|</nowiki>PAGE1|PAGE2}} &rarr; {{For||PAGE1|PAGE2}}
 
 
 
;Variations
 
As with {{tl|Other uses}}, there are a whole family of "for" templates.
 
 
 
* {{tlx|For2|OTHER TOPIC|CUSTOM TEXT}} &rarr; {{For2|OTHER TOPIC|CUSTOM TEXT}}
 
 
 
* {{tlx|For example|Pagename|Piped link name}} &rarr; {{For example|Pagename|Piped link name}}
 
 
 
===="For other uses of ..., see ..." ====
 
* {{tlx|Other uses of}} (disambiguous) &rarr; {{Other uses of}}
 
* {{tlx|Other uses of|TOPIC}} (disambiguous) &rarr; {{Other uses of|TOPIC}}
 
* {{tlx|Other uses of|TOPIC|PAGE1}} &rarr; {{Other uses of|TOPIC|PAGE1}}
 
 
 
===="For more details on ..., see ..."====
 
{{tlx|Details}} is used to make [[wikipedia:summary style|summary style]] explicit. To be used in a section for which there is also a separate article on the subject.
 
* {{tlx|Details|Article|TOPIC}} &rarr; {{Details|Article|TOPIC}}
 
 
 
{{tl|Details3}} allows any text to links:
 
* {{tlx|Details3|<nowiki>[[article 1]], [[article 2]], and [[article 3]]</nowiki>|TOPIC}} &rarr; {{Details3|[[article 1]], [[article 2]], and [[article 3]]|TOPIC}}
 
 
 
===="Further information: ..."====
 
* {{tlx|See|OTHER TOPIC}} &rarr; {{see|OTHER TOPIC}}
 
 
 
Example with multiple parameters
 
* {{tlx|See|Iraq and weapons of mass destruction|Saddam Hussein and al-Qaeda|Downing Street memo|Bush-Blair memo}} &rarr; {{see|Iraq and weapons of mass destruction|Saddam Hussein and al-Qaeda|Downing Street memo|Bush-Blair memo}}
 
 
 
* {{tlx|Further|<nowiki>[[Article 1]], [[Article 2]], and [[Article Something#3|Article 3]]</nowiki>}} &rarr; {{Further|[[Article 1]], [[Article 2]], and [[Article Something#3|Article 3]]}}
 
This template takes a single parameter of any length.
 
 
 
===="See also ..."====
 
* {{tlx|See also|OTHER TOPIC}} &rarr; {{See also|OTHER TOPIC}}
 
:Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.
 
 
 
* {{tlx|See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}} &rarr; {{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}
 
 
 
===="... redirects here. For other uses, see ..."====
 
* {{tlx|Redirect|REDIRECT}} (disambiguous) &rarr; {{Redirect|REDIRECT}}
 
* {{tlx|Redirect|REDIRECT<nowiki>||</nowiki>PAGE1}} &rarr; {{Redirect|REDIRECT||PAGE1}}
 
* {{tlx|Redirect|REDIRECT|USE1|PAGE1}} &rarr; {{Redirect|REDIRECT|USE1|PAGE1}}
 
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}} &rarr; {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
 
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} &rarr; {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
 
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} &rarr; {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
 
* {{tlx|Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} &rarr; {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
 
 
 
;Variations
 
* {{tlx|Redirect-acronym|TERM|PAGE}} &rarr; {{Redirect-acronym|TERM|PAGE}}
 
* {{tlx|Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) &rarr; {{Redirect2|REDIRECT1|REDIRECT2}}
 
* {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}} &rarr; {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
 
* {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}} &rarr; {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
 
* {{tlx|Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} &rarr; {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
 
* {{tlx|Redirect3|REDIRECT|TEXT}} &rarr; {{Redirect3|REDIRECT|TEXT}}
 
* {{tlx|Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) &rarr; {{Redirect4|REDIRECT1|REDIRECT2}}
 
* {{tlx|Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) &rarr; {{Redirect6|REDIRECT|USE1|PAGE1}}
 
* {{tlx|Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}} &rarr; {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
 
:Note: If the number of pages redirecting to the target page is two, {{tlx|Redirect2}} can be used instead. If the number is three and there are three corresponding disambiguation pages, {{tlx|Redirect10}} can be used.
 
* {{tlx|Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}} (disambiguous) &rarr; {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
 
 
 
====Other people====
 
* {{tlx|Other persons}} (disambiguous) &rarr; {{Other persons}}
 
* {{tlx|Other persons|NAME}} (disambiguous) &rarr; {{Other persons|NAME}}
 
* {{tlx|Other persons|NAME|PAGE}} &rarr; {{Other persons|NAME|PAGE}}
 
* {{tlx|Other persons|NAME|PAGE|named{{=}}titled}} &rarr; {{Other persons|NAME|PAGE|named=titled}}
 
* {{tlx|Other people2|PAGE}} &rarr; {{Other people2|PAGE}}
 
* {{tlx|Other people3}} (disambiguous) &rarr; {{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) &rarr; {{Other people3|PERSON1}}
 
* {{tlx|Other people3|PERSON1|PERSON2}} (disambiguous) &rarr; {{Other people3|PERSON1|PERSON2}}
 
* {{tlx|Other people3|PERSON1|PERSON2|PAGE2}} &rarr; {{Other people3|PERSON1|PERSON2|PAGE2}}
 
* {{tlx|Other people3|PERSON1<nowiki>||</nowiki>PAGE2}} &rarr; {{Other people3|PERSON1||PAGE2}}
 
* {{tlx|Other people5|NAME1|NAME2|NAME3|NAME4}} &rarr; {{Other people5|NAME1|NAME2|NAME3|NAME4}}
 
:Note: defaults to "named" as in {{tl|Other persons}}, exists for options like "nicknamed", "known as", etc.
 
 
 
====Other places====
 
* {{tlx|Other places}}, analogous to {{tl|Other uses}} (disambiguous) &rarr; {{otherplaces}}
 
* {{tlx|Other places|PAGE}}, analogous to {{tl|Other uses2}}(disambiguous) &rarr; {{otherplaces|PAGE}}
 
* {{tlx|Other places3|PAGE}}, analogous to {{tl|Other uses}} &rarr; {{otherplaces3|PAGE}}
 
 
 
====Other hurricanes====
 
For articles on [[storm]]s:
 
* {{tlx|Other hurricanes}} (disambiguous) &rarr; {{Other hurricanes}}
 
* {{tlx|Other hurricanes|DISAMBIG}} &rarr; {{Other hurricanes|DISAMBIG}}
 
* {{tlx|Other hurricanes|DISAMBIG|THIS}} &rarr; {{Other hurricanes|DISAMBIG|THIS}}
 
* {{tlx|Other hurricanes|<nowiki>|</nowiki>THIS}} &rarr; {{Other hurricanes||THIS}}
 
 
 
====Other ships====
 
For articles on [[ship]]s:
 
* {{tlx|Other ships|SHIP1}} &rarr; {{Other ships|SHIP1}}
 
 
 
===Distinguish===
 
===="Not to be confused with ..."====
 
* {{tlx|Distinguish|PAGE1}} &rarr; {{Distinguish|PAGE1}}
 
* {{tlx|Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}} &rarr; {{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
 
* {{tlx|Distinguish2|TEXT}} &rarr; {{Distinguish2|TEXT}}
 
 
 
====".. redirects here. It is not to be confused with ..."====
 
* {{tlx|Redirect-distinguish|REDIRECT|PAGE1}} &rarr; {{Redirect-distinguish|REDIRECT|PAGE1}}
 
* {{tlx|Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}} &rarr; {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
 
* {{tlx|Redirect-distinguish2|REDIRECT|TEXT}} &rarr; {{Redirect-distinguish2|REDIRECT|TEXT}}
 
 
 
===="... is a common misspelling of ...====
 
* {{tlx|Misspelling|PAGE2}} &rarr; {{Misspelling|PAGE2}}
 
 
 
==="Main article: ..." and more===
 
* {{tlx|Main|Main Article}} &rarr; {{Main|Main Article}}
 
* {{tlx|Main|Main Article|Article2}} &rarr; {{Main|Main Article|Article2}}
 
* {{tlx|Main list|Article1}} &rarr; {{Mainlist|Article1}}
 
* {{tlx|ArticlePreceeding|George Washington}} &rarr; {{ArticlePreceeding|George Washington}}
 
* {{tlx|ArticleSucceeding|Thomas Jefferson}} &rarr; {{ArticleSucceeding|Thomas Jefferson}}
 
* {{tlx|ArticlePair|George Washington|Thomas Jefferson}} &rarr; {{ArticlePair|George Washington|Thomas Jefferson}}
 
 
 
===Wikipedia self-reference===
 
* {{tlx|Selfref|ANYTEXT}} &rarr; {{Selfref|ANYTEXT}}
 
:Note: 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: [[Wikipedia:Manual of Style (self-references to avoid)|Manual of Style (self-references to avoid)]] for more details).
 
 
 
===Categories===
 
Category-specific templates produce bold category names.
 
* {{tlx|Category see also|THIS|THAT|THE OTHER}} &rarr; {{Category see also|THIS|THAT|THE OTHER}}
 
 
 
* {{tlx|Related category|CAT2}} &rarr; {{Related category|CAT2}}
 
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.
 
 
 
* {{tlx|CatPreceding|OTHER TOPIC}} &rarr; {{CatPreceding|OTHER TOPIC}}
 
* {{tlx|CatSucceeding|OTHER TOPIC}} &rarr; {{CatSucceeding|OTHER TOPIC}}
 
* {{tlx|Category pair|TOPIC1|TOPIC2}} &rarr; {{Category pair|TOPIC1|TOPIC2}}
 
 
 
* {{tlx|Contrast|OTHERCAT}} &rarr; {{Contrast|OTHERCAT}}
 
* {{tlx|Contrast2|OTHERCAT}} (plural) &rarr; {{Contrast2|OTHERCAT}}
 
 
 
===Notes===
 
'''Do not use [[Wikipedia:Substitution|subst:]] with these templates''', as that will prevent:
 
# propagating changes as the template is modified; and the
 
# ''[[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|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 {{tl|dablink}} instead? Before creating a new template, see: [[Wikipedia:Template namespace|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: [[Wikipedia:Template sandbox and test cases|Template sandbox and test cases]].
 
 
 
===See also===
 
* [[WP:Hatnote]]
 
* [[:Category:Hatnote templates]]
 
 
 
{{Navbox hatnote templates|state=collapsed}}<noinclude>
 
 
 
{{Documentation}} <!-- so this is for the /doc page of this documentation-template -->
 
 
 
[[Category:Hatnote templates documentation|Documentation]]
 
 
 
</noinclude>
 

Latest revision as of 16:13, 6 September 2020