Template:Distinguish/doc - Revision history

Caleb Cooper: Text replacement - "[[WP:" to "[[Wikipedia:WP:"

2020-10-21T08:12:55Z

Text replacement - "[[WP:" to "[[Wikipedia:WP:"

← Older revision		Revision as of 08:12, 21 October 2020
Line 5:		Line 5:

	== Description ==		== Description ==
	It renders a [[WP:HAT\|hatnote]] to remind readers about the existence of one or more articles or elements whose title(s) is/are similar to this page. It is used in cases where the distinction between the title(s) is/are obvious that it does not need further explanation.		It renders a [[Wikipedia:WP:HAT\|hatnote]] to remind readers about the existence of one or more articles or elements whose title(s) is/are similar to this page. It is used in cases where the distinction between the title(s) is/are obvious that it does not need further explanation.

	For cases where an explanation is required, use {{tl\|For}} and {{tl\|About}}. For use on category pages, the corresponding template is {{Tl\|Category distinguish}}.		For cases where an explanation is required, use {{tl\|For}} and {{tl\|About}}. For use on category pages, the corresponding template is {{Tl\|Category distinguish}}.
Line 39:		Line 39:
	: {{About\|the board game\|the card game\|Reversis}}		: {{About\|the board game\|the card game\|Reversis}}

	{{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 [[Wikipedia:WP:TRHAT\|avoid trivial uses]].

	== TemplateData ==		== TemplateData ==

Caleb Cooper at 16:51, 15 October 2020

2020-10-15T16:51:41Z

@@ Line 91: / Line 91: @@
+}
 </templatedata>
 <includeonly>{{sandbox other||

Caleb Cooper: 1 revision imported

2020-10-15T07:59:08Z

1 revision imported

← Older revision	Revision as of 07:59, 15 October 2020
(No difference)

w>The Squirrel Conspiracy: -w:en:

2020-05-01T06:03:25Z

-w:en:

New page

{{Documentation subpage}}

{{High-use| 65005 }}
{{Lua|Module:Distinguish}}

== Description ==
It renders a [[WP:HAT|hatnote]] to remind readers about the existence of one or more articles or elements whose title(s) is/are similar to this page. It is used in cases where the distinction between the title(s) is/are obvious that it does not need further explanation.

For cases where an explanation is required, use {{tl|For}} and {{tl|About}}. For use on category pages, the corresponding template is {{Tl|Category distinguish}}.

== Usage ==
It is the standard usage:
{{tlx|Distinguish|Foo}} → {{Distinguish|Foo}}

This hatnote can be used to distinguish from multiple articles:
{{tlx|Distinguish|Foo|Bar}} → {{Distinguish|Foo|Bar}}
{{tlx|Distinguish|Foo|Bar|Gaz}} → {{Distinguish|Foo|Bar|Gaz}}

You may customize the text too. Use {{para|text}}. For example:
{{tlx|Distinguish|text {{=}} custom [[text]], or [[foo]], a common example term}} → {{Distinguish|text = custom [[text]], or [[foo]], a common example term}}

== When to use ==
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]]
: {{Distinguish|Comma}}

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, {{tlx|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:
: {{cross}} [[Reversi]]
: {{Distinguish|Reversis}}

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

In this case you should use {{tlx|about}} instead of {{tlc|distinguish}}. The difference is to provide explanatation upfront without requiring the reader to click through and differentiate the terms on their own.
: {{tick}} [[Reversi]]
: {{About|the board game|the card game|Reversis}}

{{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]].

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Name of article",
"description": "Name of article that you want to link to",
"type": "wiki-page-name",
"suggested": true
},
"2": {
"label": "Optional additional article to link (2)",
"description": "Optional additional article to link",
"type": "wiki-page-name"
},
"3": {
"label": "Optional additional article to link (3)",
"description": "Optional additional article to link",
"type": "wiki-page-name"
},
"4": {
"label": "Optional additional article to link (4)",
"description": "Optional additional article to link",
"type": "wiki-page-name"
},
"text": {
"label": "Custom text",
"description": "Custom message in wikitext; e.g. \"[[foo]] and [[bar]]\" produces \"Not to be confused with [[foo]] and [[bar]].\"",
"type": "string"
},
"selfref": {
"label": "Self reference",
"description": "If set, marks note as being a self reference, to not be shown when content is reused",
"type": "boolean"
}

},
"description": "A hatnote used when there is an ambiguity in an article's title.",
"paramOrder": [
"1",
"2",
"3",
"4",
"text",
"selfref"
],
"format": "inline"
}
</templatedata>

== Redirects ==
* {{tl|Confused}}
* {{tl|Confuse}}
* {{tl|Misspelling}}

== See also ==
* {{tl|About}}
* {{tl|Category distinguish}}
* {{tl|For}}
* {{tl|Redirect}}
* {{tl|R from misspelling}}

{{Hatnote templates}}

<includeonly>{{sandbox other||

[[Category:Disambiguation and redirection templates]]
[[Category:Hatnote templates]]
}}</includeonly>