Template:Distinguish

Template documentation[view] [edit] [history] [purge]

{{dist}}
{{ntbcw}}
{{confuse}}

This template is used on approximately 109,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:distinguish

Description edit

The "distinguish" template produces a hatnote to point out to our readers the existence of one or more articles whose title(s) is, or 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 {{For}} and {{About}}. For use on category pages, the corresponding template is {{Category distinguish}}.

Usage edit

Here is an example of its standard usage on the article about the mathematical Astroid:

{{distinguish|Asteroid}} →

This hatnote can be used to distinguish the topic from multiple other topics, as for Corundum or Bangala language:

{{distinguish|Carborundum|Conundrum}} → {{distinguish|Bangla language|Mbangala language|Ngala language}} →

The |text= parameter can be used to create customized text, in case context is required. An example is on the article Phobos (mythology), which contains a customized hatnote to distinguish it and "Phoebus" (a redirect of Apollo). Both links lead to topics about Greek gods, so the parenthetical disambiguation in "Phobos (mythology)" is insufficient to disambiguate the two. Since it is typically not preferable to link a redirect in a hatnote, the article "Apollo" is linked to directly and a short explanation fills in the necessary context:

{{distinguish|text = 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 ...an [[epithet]] of the [[Greek]] god [[Apollo]].

When the target is a disambiguation page, display of the parentheses may be avoided by escaping the vertical bar using the magic word {{!}}:

{{distinguish|Crossfire (disambiguation){{!}}Crossfire}} →

The escape is necessary, otherwise the template will read the next text as another topic:

{{distinguish|Crossfire (disambiguation)|Crossfire}} →

When to use edit

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:

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 {{about}} instead of {{distinguish}}. The difference is to provide explanation upfront without requiring the reader to click through and differentiate the terms on their own.

Reversi

This article is about the board game. For the card game, see Reversis.

{{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 edit

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Distinguish in articles based on its TemplateData.

TemplateData for Distinguish

<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>

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Hatnote group}} {{Self-reference}}
For and about	{{For}} {{For-text}} (for custom text) {{For-multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other storms}} {{Other places}} {{Other ships}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text) {{About-distinguish}} {{About-distinguish-text}} (for custom text) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}}
For use in sections	{{Main}} {{Main if exists}} {{Main list}} {{Further}} {{Further-text}} (for custom text) {{Further interlanguage link}} {{See also}} {{See also if exists}} {{See also-text}} (for custom text) {{For outline}} {{For timeline}}
Special	{{Broader}} {{For introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{About year}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages

Hatnote templates v t e
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic
{{Hatnote}} {{Hatnote group}} {{Self-reference}}
For and about
{{For}} {{For-text}} (for custom text) {{For-multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics
{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other storms}} {{Other places}} {{Other ships}}
Redirect
{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish
{{Distinguish}} (supports custom text) {{About-distinguish}} {{About-distinguish-text}} (for custom text) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}}
For use in sections
{{Main}} {{Main if exists}} {{Main list}} {{Further}} {{Further-text}} (for custom text) {{Further interlanguage link}} {{See also}} {{See also if exists}} {{See also-text}} (for custom text) {{For outline}} {{For timeline}}
Special
{{Broader}} {{For introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific
{{About year}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages

Template:Distinguish

Contents

Description edit

Usage edit

When to use edit

TemplateData edit

Redirects edit

See also edit