View source for Template:Distinguish/doc

{{Documentation subpage}}
<!-- Please add categories at the bottom of this page, and interwikis at Wikidata (see Wikipedia:Wikidata) -->
{{High-use| 65005 }}
{{Lua|Module:distinguish}}

== Description ==
The "distinguish" template produces a [[WP:HAT|hatnote]] to point out to our readers the existence of one or more articles whose title(s) is/are similar to the page in question. It is used in cases where the distinction between the titles is generally obvious and does not need further explanation. 

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

== Usage ==
Here is an example of its standard usage (used, for purposes of this example, with the placeholder article "Foo"; the following could be placed on a theoretical article named "Foo (song)", or perhaps one named "Fou" or "Fu"):
{{tlx|distinguish|Foo}}         → {{Distinguish|Foo}}

This hatnote can be used to distinguish the topic from multiple other topics:
{{tlx|distinguish|Foo|Bar}} → {{Distinguish|Foo|Bar}}
{{tlx|distinguish|Foo|Bar|Gaz}} → {{Distinguish|Foo|Bar|Gaz}}

It can also be used to customize the text that will appear.  You may do this using the template's {{para|text}} parameter. For example, from the Wikipedia article on [[Phobos (mythology)]], an article about a Greek god that is also the name of one of the moons of Mars, and where the word "Phoebus", quite similar to "Phobos", has an altogether different meaning.  Note that for ease of understanding, terms with parenthetical disambiguation should usually be [[WP:pipe|piped]]: 
{{tlx|distinguish|text {{=}} the Martian moon &#91;&#91;Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god &#91;&#91;Apollo]]}} → {{Distinguish|text = the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]] }}  

Note that a final period is automatically added at the end of the sentence, and that only one blue link is used per disambiguated topic (i.e, do not type <code><nowiki>...an [[epithet]] of the [[Greek]] god [[Apollo]]. </nowiki></code>

It may also be appropriate to place a similar hatnote on the article for [[Phobos (moon)]] to distinguish it from the article on [[Phobos (mythology)]] and the article on Apollo, though it is probably unnecessary to place yet another hatnote on the article on [[Apollo]], since most readers searching for "Apollo Phoebus" will get there by simply typing "Apollo" in the Wikipedia search box.

== 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 explanation 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 (computer science)|bar]]\" produces \"Not to be confused with [[foo]] and [[Bar (computer science)|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}}
* {{tl|Ntbcw}}

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

{{Hatnote templates}}

<includeonly>{{sandbox other||
<!-- Add categories below this line, and interwikis at Wikidata -->
[[Category:Disambiguation and redirection templates]]
[[Category:Hatnote templates]]
}}</includeonly>