Template:Distinguish/doc

Description
It renders a 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 For and About.

Usage
It is the standard usage: →

This hatnote can be used to distinguish from multiple articles: → →

You may customize the text too. Use text. For example: →

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

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, 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:
 * Reversi

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 instead of. The difference is to provide explanatation upfront without requiring the reader to click through and differentiate the terms on their own.
 * ✅ Reversi

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
{	"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" }

Redirects

 * Confused
 * Confuse
 * Misspelling