Difference between revisions of "Template:Hatnote templates documentation"

From LIMSWiki
Jump to navigationJump to search
m (Protected "Template:Hatnote templates documentation" ([edit=sysop] (indefinite) [move=sysop] (indefinite)))
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentation subpage}}<!-- Note this is a documentation page currently aimed at multiple (all?) hatnote templates. (January 2011).  
{{documentation subpage}}<!-- Note this is a documentation page currently aimed at multiple (all?) hatnote templates. (January 2011).  
--><div style="float:right; padding: 0 1em;">{{navbar|Hatnote templates documentation}}</div>
--><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===
===Generic===
Line 14: Line 11:
{{tl|About}} is the main template for noting 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".''
''Note. When used in the main namespace, the word "page" in the following hatnotes is replaced by "article".''


* {{tlx|About|USE1}} &rarr; {{About|USE1}}
* {{tlx|About|USE1}} &rarr; {{About|USE1}}
Line 20: Line 17:
* {{tlx|About|USE1|USE2|PAGE2}} (When there is only one other use) &rarr; {{About|USE1|USE2|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|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|USE4|PAGE4|USE5|PAGE5}} (When there are up to five other uses — You should generally create a [[Help: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}} (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}} (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}}
Line 79: Line 76:


===="''For more details on …, see …''"====
===="''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}} is used to make 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}}
* {{tlx|Details|Laboratory informatics|the application of technology to laboratories}} &rarr; {{Details|Laboratory informatics|the application of technology to laboratories}}


{{tl|Details3}} allows any text to links:
{{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}}
* {{tlx|Details3|<nowiki>[[Laboratory informatics]], [[Laboratory]], and [[Informatics]]</nowiki>|the application of technology to laboratories}} &rarr; {{Details3|[[Laboratory informatics]], [[Laboratory]], and [[Informatics]]|the application of technology to laboratories}}


===="''… redirects here. For other uses, see …''"====
===="''… redirects here. For other uses, see …''"====
Line 113: Line 110:
===="''Further information: …''"====
===="''Further information: …''"====
* {{tlx|See|OTHER TOPIC}} &rarr; {{see|OTHER TOPIC}}
* {{tlx|See|OTHER TOPIC}} &rarr; {{see|OTHER TOPIC}}
* {{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|See|Laboratory informatics|Laboratory|Informatics}} &rarr; {{see|Laboratory informatics|Laboratory|Informatics}}
* {{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]]}}
* {{tlx|Further|<nowiki>[[Laboratory informatics]], [[Laboratory]], and [[Informatics]]</nowiki>}} &rarr; {{Further|[[Laboratory informatics]], [[Laboratory]], and [[Informatics]]}}


===Other people, places, etcetera===
===Other people, places, etcetera===
Line 167: Line 164:
* {{tlx|ArticlePair|George Washington|Thomas Jefferson}} &rarr; {{ArticlePair|George Washington|Thomas Jefferson}}
* {{tlx|ArticlePair|George Washington|Thomas Jefferson}} &rarr; {{ArticlePair|George Washington|Thomas Jefferson}}


===Wikipedia self-reference===
===LIMSwiki self-reference===
* {{tlx|Selfref|ANYTEXT}} &rarr; {{Selfref|ANYTEXT}}
* {{tlx|Selfref|ANYTEXT}} &rarr; {{Selfref|ANYTEXT}}
:See: [[Wikipedia:Manual of Style (self-references to avoid)|Manual of Style (self-references to avoid)]] for more details.


===Categories===
===Categories===
Line 193: Line 189:


===Notes===
===Notes===
'''Do not use [[Wikipedia:Substitution|subst:]] with these templates''', as that will prevent:  
'''Do not use [[LIMSWiki:Substitution|subst:]] with these templates''', as that will prevent:  
# propagating changes as the template is modified; and the
# propagating changes as the template is modified; and the
# ''[[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|What links here]]'' (WLH) listing.
# ''[[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|What links here]]'' (WLH) listing.
Line 199: Line 195:
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:
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]].
# 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.
# 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?
# 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]].
# 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?


===See also===
===See also===
* [[WP:Hatnote]]
* {{tl|hatnote templates documentation}} (generic)
* [[:Category:Hatnote templates]]
* [[:Category:Hatnote templates]]



Latest revision as of 23:00, 4 April 2024

Generic

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

Other uses (of the title)

"This page is about … For other uses …"

{{About}} is the main template for noting other uses.

Note. When used in the main namespace, the word "page" in the following hatnotes is replaced by "article".

  • {{About|USE1}}
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name — Note the empty second parameter) →
  • {{About|USE1|USE2|PAGE2}} (When there is only one other use) →
  • {{About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) →
  • {{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) →
  • {{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) →
  • {{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}}
  • {{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) →
  • {{About|||PAGE1|and|PAGE2}}
Note: {{for||PAGE1|PAGE2}} produces the same result.
Note: this hatnote says "section", instead of "article" or "page".

"See also …"

Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.

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

Variations

As with {{Other uses}}, there are a whole family of "for" templates.

  • {{For2|OTHER TOPIC|CUSTOM TEXT}}

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

Here are the variations and (when appropriate) the equivalents using the {{About}}, {{Other uses}} or {{For}} templates.

Note: adds "(disambiguation)" to whatever is input as the PAGE1.
Note: {{Other uses|PAGE1 (disambiguation)}} produces the same result.
Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.

"For other uses of …, see …"

"For more details on …, see …"

{{Details}} is used to make summary style explicit. To be used in a section for which there is also a separate article on the subject.

  • {{Details|Laboratory informatics|the application of technology to laboratories}}

{{Details3}} allows any text to links:

"… redirects here. For other uses, see …"

  • {{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}}
  • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
  • {{Redirect3|REDIRECT|TEXT}}
  • {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) →
  • {{Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) →
  • {{Redirect6|REDIRECT|USE1|PAGE1|‌|PAGE2}}
  • {{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.
... Not to be confused with ...

"Further information: …"

Other people, places, etcetera

Other people

Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.

Other places

Other hurricanes

For articles on storms:

Other ships

For articles on ships:

Distinguish

"Not to be confused with …"

"… redirects here. It is not to be confused with …"

"Main article: …" etcetera

LIMSwiki self-reference

Categories

Category-specific templates produce bold category names.

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.

Family names

Lists

User pages

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 {{dablink}} instead?
  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?

See also

[edit] [purge] Template documentation

The {{Hatnote templates documentation}} template is a template documentation box for all of the Otheruses templates. It takes no parameters, and should not be substed.

See also