Difference between revisions of "Template:Distinguish"

From MansunWiki
Jump to: navigation, search
m
 
Line 1: Line 1:
{{Documentation subpage}}
+
{{#if:{{{1|}}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
|{{Hatnote|Not to be confused with [[:{{trim|{{{1}}}}}]]{{
 
+
    #if: {{{3|}}}{{{4|}}}
== Usage ==
+
    | , [[:{{trim|{{{2}}}}}]], {{
<nowiki>{{Distinguish | foo}}</nowiki> {{Distinguish|foo}}
+
      #if: {{{4|}}}
 
+
      | [[:{{trim|{{{3}}}}}]], or [[:{{trim|{{{4}}}}}]]
<nowiki>{{Distinguish | foo | bar}}</nowiki> {{Distinguish|foo|bar}}
+
      | or [[:{{trim|{{{3}}}}}]]
 
+
      }}
<nowiki>{{Distinguish | foo | bar | baz}}</nowiki> {{Distinguish|foo|bar|baz}}
+
    | {{
 
+
      #if: {{{2|}}}
This hatnote is generally used when there is an ambiguity that is not necessarily literal, but one that can be reasonably assumed to exist for a portion of the readership substantial enough to warrant a hatnote. When applying it, care should be taken to [[WP:TRHAT|avoid trivial uses]].
+
      | &nbsp;or [[:{{trim|{{{2}}}}}]]
 
+
      }}
== Redirects ==
+
    }}.
* {{tl|Not to be confused with}}
+
  }}
* {{tl|Confused}}
+
}}<noinclude><!-- splitting these lines causes {{Documentation}} template to terminate green shading when Distinguish is used in /doc pages. -->
* {{tl|Confuse}}
+
{{Documentation}}
* {{tl|Misspelling}}
+
<!-- Add categories to the /doc subpage and interwikis to Wikidata, not here! -->
 
+
</noinclude>
== See also ==
+
* {{tl|Distinguish2}}, for multiple disambiguation targets or prepending "the".
+
* {{tl|About}}, if the page title ''does'' (without misspelling) describe the other target (since the user is then aided by a clear statement of how the page's topic differs from the other target's topic).
+
 
+
{{Hatnote templates documentation}}
+
 
+
 
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
<!-- Categories go below and interwikis go to Wikidata, thank you! -->
+
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
+
[[Category:Hatnote templates]]
+
 
+
}}
+
<templatedata>
+
{
+
"params": {
+
"1": {
+
"label": "Name of article",
+
"description": "Name of article that you want to link to",
+
"type": "wiki-page-name",
+
"required": true
+
},
+
"2": {
+
"label": "Optional additional article to link",
+
"description": "Optional additional article to link",
+
"type": "wiki-page-name"
+
},
+
"3": {
+
"label": "Optional additional article to link",
+
"description": "Optional additional article to link",
+
"type": "wiki-page-name"
+
},
+
"4": {
+
"label": "Optional additional article to link",
+
"description": "Optional additional article to link",
+
"type": "wiki-page-name"
+
}
+
},
+
"description": "A hatnote used when there is an ambiguity in an article's title.",
+
"paramOrder": [
+
"1",
+
"2",
+
"3",
+
"4"
+
]
+
}
+
</templatedata>
+
</includeonly>
+

Latest revision as of 23:40, 16 July 2015

[view] [edit] [history] [purge] Template-info.svg Template Documentation

Usage

{{Distinguish | foo}} {{#invoke:Hatnote|hatnote}}

{{Distinguish | foo | bar}} {{#invoke:Hatnote|hatnote}}

{{Distinguish | foo | bar | baz}} {{#invoke:Hatnote|hatnote}}

This hatnote is generally used when there is an ambiguity that is not necessarily literal, but one that can be reasonably assumed to exist for a portion of the readership substantial enough to warrant a hatnote. When applying it, care should be taken to avoid trivial uses.

Redirects

See also

  • {{Distinguish2}}, for multiple disambiguation targets or prepending "the".
  • {{About}}, if the page title does (without misspelling) describe the other target (since the user is then aided by a clear statement of how the page's topic differs from the other target's topic).

This overview: view · talk · edit


Hatnote templates

{{#invoke:Hatnote|hatnote}} Hatnotes must be at the very top of the page or section.

Generic hatnote

  • {{Hatnote|CUSTOM TEXT}} → {{#invoke:Hatnote|hatnote}}
{{Hatnote|For other senses of this term, see [[etc…]]}} → {{#invoke:Hatnote|hatnote}}

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}} → {{#invoke:main|main}}
  • {{Main|Main Article|Article2}} → {{#invoke:main|main}}
  • {{Main list|Article1}} → {{#invoke:Hatnote|hatnote}}

"For more details on …, see …"

{{Details}} can supplement {{Main}} in summary sections, or can indicate more details in nonsummary sections:

{{Details3}} allows changing the displayed name for links. Unlike {{Details}}, it requires bracketed link notation:

"See also …"

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

"Further information: …"

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}}Template:About
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) → Template:About
  • {{About|USE1|USE2|PAGE2}} (When there is only one other use) → Template:About
  • {{About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) → Template:About
  • {{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}} (Using the {{!}} magic word to give the link a different title) → Template:About
  • {{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) → Template: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) → Template: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) →Template:About
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}Template: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) → Template:About
  • {{About|||PAGE1|and|PAGE2}}Template:About
Note: {{for||PAGE1|PAGE2}} produces the same result.
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.

"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}} → {{#invoke:Hatnote|hatnote}}
  • {{For|OTHER TOPIC|PAGE1}} → {{#invoke:Hatnote|hatnote}}
  • {{For|OTHER TOPIC|PAGE1|PAGE2}} → {{#invoke:Hatnote|hatnote}}
  • {{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}} → {{#invoke:Hatnote|hatnote}}
  • {{For||PAGE1|PAGE2}} → {{#invoke:Hatnote|hatnote}}
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"
It also supports up to three topics:
  • {{For2|OTHER TOPIC|CUSTOM TEXT|OTHER TOPIC 2|CUSTOM TEXT 2}}Template:For2
  • {{For2|OTHER TOPIC|CUSTOM TEXT|OTHER TOPIC 2|CUSTOM TEXT 2|OTHER TOPIC 3|CUSTOM TEXT 3}}Template:For2

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

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

{{safesubst:#invoke:anchor|main}}

Variations
... Not to be confused with ...

Similar proper names ("For other people named ...")

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 ships

For articles on ships:

Distinguish

"Not to be confused with …"

  • {{Distinguish|PAGE1}} → {{#invoke:Hatnote|hatnote}}
  • {{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}} → {{#invoke:Hatnote|hatnote}}
  • {{Distinguish2|TEXT}}Template:Distinguish2

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

"For technical reasons, … redirects here. For … , see … ."

Family names

Template:Further

Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)

These hatnotes are topic-specific. They are documented at their template page.

Categories

Category-specific templates:

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.

Lists

Template:Further

User pages

Template:This user talk

Notes

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.

Template:Hatnote templates <templatedata> { "params": { "1": { "label": "Name of article", "description": "Name of article that you want to link to", "type": "wiki-page-name", "required": true }, "2": { "label": "Optional additional article to link", "description": "Optional additional article to link", "type": "wiki-page-name" }, "3": { "label": "Optional additional article to link", "description": "Optional additional article to link", "type": "wiki-page-name" }, "4": { "label": "Optional additional article to link", "description": "Optional additional article to link", "type": "wiki-page-name" } }, "description": "A hatnote used when there is an ambiguity in an article's title.", "paramOrder": [ "1", "2", "3", "4" ] } </templatedata>