Difference between revisions of "Template:Distinguish/doc"

From blackwiki
Jump to navigation Jump to search
imported>Codename Lisa
imported>Codename Lisa
(Overhaul)
Line 3: Line 3:
  
 
{{Lua|Module:Distinguish}}
 
{{Lua|Module:Distinguish}}
 +
This template renders a [[WP:HAT|hatnote]] intended to inform the reader of the existence of one or more articles whose title(s) bears a strong resemblance to the current article. This template is used in the cases where the distinction between the titles is so obvious that the reader needs no further explanation. For cases where an explanation is required, use {{tl|For}} and {{tl|About}}.
  
== Usage ==
+
== Syntax ==
 
{{tlx|distinguish|PAGE1}} {{distinguish|PAGE1}}
 
{{tlx|distinguish|PAGE1}} {{distinguish|PAGE1}}
  
Line 11: Line 12:
 
{{tlx|distinguish|PAGE1|PAGE2|PAGE3}} {{distinguish|PAGE1|PAGE2|PAGE3}}
 
{{tlx|distinguish|PAGE1|PAGE2|PAGE3}} {{distinguish|PAGE1|PAGE2|PAGE3}}
  
 +
== Examples ==
 
This hatnote is generally used when readers have misspelled their desired title, and the error would be apparent by simply displaying the alternative term without further explanation.  For example, consider a reader looking for the punctuation mark who instead ends up at [[coma]]:  
 
This hatnote is generally used when readers have misspelled their desired title, and the error would be apparent by simply displaying the alternative term without further explanation.  For example, consider a reader looking for the punctuation mark who instead ends up at [[coma]]:  
 
<blockquote>[[Coma]] → {{Distinguish|Comma}}</blockquote>
 
<blockquote>[[Coma]] → {{Distinguish|Comma}}</blockquote>
Line 25: Line 27:
  
 
{{tlc|Distinguish}} should only be used when the ambiguity exists for a portion of the readership that is sufficient to warrant a hatnote. Care should be taken to [[WP:TRHAT|avoid trivial uses]].
 
{{tlc|Distinguish}} should only be used when the ambiguity exists for a portion of the readership that is sufficient to warrant a hatnote. Care should be taken to [[WP:TRHAT|avoid trivial uses]].
 
== Redirects ==
 
* {{tl|Not to be confused with}}
 
* {{tl|Confused}}
 
* {{tl|Confuse}}
 
* {{tl|Misspelling}}
 
 
== See also ==
 
* {{tl|Distinguish2}}, for multiple disambiguation targets or prepending "the".
 
* {{tl|About}}, links the reader to other articles with similar titles or concepts that they may have been seeking instead.
 
 
{{Hatnote templates}}
 
  
 
== TemplateData ==
 
== TemplateData ==
Line 75: Line 65:
 
}
 
}
 
</templatedata>
 
</templatedata>
 +
 +
== Redirects ==
 +
* {{tl|Not to be confused with}}
 +
* {{tl|Confused}}
 +
* {{tl|Confuse}}
 +
* {{tl|Misspelling}}
 +
 +
== See also ==
 +
* {{tl|Distinguish2}}, for multiple disambiguation targets or prepending "the".
 +
 +
{{Hatnote templates}}
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

Revision as of 10:49, 2 May 2017

This template renders a hatnote intended to inform the reader of the existence of one or more articles whose title(s) bears a strong resemblance to the current article. This template is used in the cases where the distinction between the titles is so obvious that the reader needs no further explanation. For cases where an explanation is required, use {{For}} and {{About}}.

Syntax

{{distinguish|PAGE1}}

{{distinguish|PAGE1|PAGE2}}

{{distinguish|PAGE1|PAGE2|PAGE3}}

Examples

This hatnote is generally used when readers have misspelled their desired title, and the error would be apparent by simply displaying the alternative term without further explanation. For example, consider a reader looking for the punctuation mark who instead ends up at coma:

Coma

Readers are presumed to recognize that they actually wanted comma by merely looking at the spelling, and this case generally requires no further explanation.

However, {{distinguish}} is not suitable when the difference is not readily apparent without additional details. Consider a reader looking for a game they believe is named Reversi:

File:Red x.svg Reversi

In the above hatnote, it is not generally apparent how the suggested Reversis is different from Reversi, which is also a game.

Green check.svg ReversiScript error: No such module "about".

Using {{about}} instead of {{distinguish}}, the differences in the suggested article is explained upfront without requiring the reader to click through and differentiate the terms on their own.

{{Distinguish}} should only be used when the ambiguity exists for a portion of the readership that is sufficient to warrant a hatnote. Care should be taken to avoid trivial uses.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Distinguish

A hatnote used when there is an ambiguity in an article's title.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Name of article1

Name of article that you want to link to

Pagerequired
Optional additional article to link2

Optional additional article to link

Pageoptional
Optional additional article to link3

Optional additional article to link

Pageoptional
Optional additional article to link4

Optional additional article to link

Pageoptional

Redirects

See also

  • {{Distinguish2}}, for multiple disambiguation targets or prepending "the".