Difference between revisions of "Template:Distinguish/doc"

From blackwiki
Jump to navigation Jump to search
imported>Nihiltres
(Changed TemplateData format to inline; it should not use block format.)
imported>Zyxw
m (add {{TemplateData header}} (via JWB))
Line 38: Line 38:
 
{{Hatnote templates}}
 
{{Hatnote templates}}
  
 
+
== TemplateData ==
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
{{TemplateData header}}
<!-- Categories go below and interwikis go to Wikidata, thank you! -->
 
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
 
[[Category:Hatnote templates]]
 
 
 
}}
 
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 80: Line 75:
 
}
 
}
 
</templatedata>
 
</templatedata>
</includeonly>
+
 
 +
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 +
<!-- Categories go below and interwikis go to Wikidata, thank you! -->
 +
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
 +
[[Category:Hatnote templates]]
 +
 
 +
}}</includeonly>

Revision as of 00:26, 24 February 2017

Usage

{{distinguish|PAGE1}}

{{distinguish|PAGE1|PAGE2}}

{{distinguish|PAGE1|PAGE2|PAGE3}}

This hatnote is generally used when there can be confusion with a similar term. This is typically 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:

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.

File: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.

Redirects

See also

  • {{Distinguish2}}, for multiple disambiguation targets or prepending "the".
  • {{About}}, links the reader to other articles with similar titles or concepts that they may have been seeking instead.

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