Template:Distinguish/doc: Difference between revisions

From The Goon Show Depository
en>Geekdiva
m (→‎When to use: Made capitalization match article title in a reference to the article itself, not within body text. This matches the other links throughout and earlier versions as well.)
m (1 revision imported)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{tsh|dist}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
<!-- Please add categories at the bottom of this page, and interwikis at Wikidata (see Wikipedia:Wikidata) -->
{{TemplateData header|editlinks=1|docpage=Distinguish/doc}}
{{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, 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 {{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|Baz}} → {{Distinguish|Foo|Bar|Baz}}
 
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 the target is a disambiguation page, display of the parentheses may be avoided by escaping the vertical bar using the [[Help:Magic words|magic word]] {{Tl|!}}:
{{Tick}}{{tlx|distinguish|Crossfire (disambiguation)&#123;&#123;&#33;&#125;&#125;Crossfire}} → {{Distinguish|Crossfire (disambiguation){{!}}Crossfire}}
The escape is necessary, otherwise the template will read the next text as another topic:
{{Cross}}{{tlx|distinguish|Crossfire (disambiguation)|Crossfire}} → {{Distinguish|Crossfire (disambiguation)|Crossfire}}
 
== 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]]
:: ''This article is about the board game. For the card game, see [[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>
<templatedata>
{
{
"description": {
"en": "Adds warning \"Not to be confused\" on the reader's page, with a short list of related pages.",
"fr": "Ajoute un avertissement \"A ne pas confondre avec\" sur la page du lecteur, avec une liste courte de pages associées."
},
"format": "inline",
"params": {
"params": {
"1": {
"1": {
"label": "Name of article",
"label": "Page 1",
"description": "Name of article that you want to link to",
"description": {
"type": "wiki-page-name",
"en": "Full name of related page",
                        "suggested": true
"fr": "Nom complet de la page relative à laquelle vous voulez faire référence."
},
"example": {
"fr": "Article_old  Article/doc  Special:MyLanguage/Articles"
},
"required": true,
"type": "wiki-page-name"
},
},
"2": {
"2": {
"label": "Optional additional article to link (2)",
"label": "Page 2",
"description": "Optional additional article to link",
"description": {
"en": "Full name of related page",
"fr": "Nom complet de la page relative à laquelle vous voulez faire référence."
},
"type": "wiki-page-name"
"type": "wiki-page-name"
},
},
"3": {
"3": {
"label": "Optional additional article to link (3)",
"label": "Page 3",
"description": "Optional additional article to link",
"description": {
"en": "Full name of related page",
"fr": "Nom complet de la page relative à laquelle vous voulez faire référence."
},
"type": "wiki-page-name"
"type": "wiki-page-name"
},
},
"4": {
"4": {
"label": "Optional additional article to link (4)",
"label": "Page 4",
"description": "Optional additional article to link",
"description": {
"en": "Full name of related page",
"fr": "Nom complet de la page relative à laquelle vous voulez faire référence."
},
"type": "wiki-page-name"
"type": "wiki-page-name"
},
},
        "text": {
"l1": {
            "label": "Custom text",
"aliases": [
            "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]].\"",
"label 1"
            "type": "string"
],
        },
"label": "Label 1",
        "selfref": {
"description": {
            "label": "Self reference",
"en": "Custom label for the link, instead of the page name.",
            "description": "If set, marks note as being a self reference, to not be shown when content is reused",
"fr": "Texte alternatif affiché pour remplacer le nom de la page relative. "
            "type": "boolean"
},
        }
"example": {
 
"fr": "Archives Documentation Actualités"
},
"default": {
"en": "Page name",
"fr": "Copie de Nom de page"
},
"type": "line"
},
"l2": {
"aliases": [
"label 2"
],
"label": "Label 2",
"description": {
"en": "Custom label for the link, instead of the page name.",
"fr": "Texte alternatif affiché pour remplacer le nom de la page relative. "
},
"default": {
"en": "Page name",
"fr": "Copie de Nom de page"
},
"type": "line"
},
"l3": {
"aliases": [
"label 3"
],
"label": "Label 3",
"description": {
"en": "Custom label for the link, instead of the page name.",
"fr": "Texte alternatif affiché pour remplacer le nom de la page relative. "
},
"default": {
"en": "Page name",
"fr": "Copie de Nom de page"
},
"type": "line"
},
"l4": {
"aliases": [
"label 4"
],
"label": "Label 4",
"description": {
"en": "Custom label for the link, instead of the page name.",
"fr": "Texte alternatif affiché pour remplacer le nom de la page relative. "
},
"default": {
"en": "Page name",
"fr": "Copie de Nom de page"
},
"type": "line"
}
},
},
"description": "A hatnote used when there is an ambiguity in an article's title.",
"paramOrder": [
"paramOrder": [
"1",
"1",
"l1",
"2",
"2",
"l2",
"3",
"3",
"l3",
"4",
"4",
                "text",
"l4"
                "selfref"
]
],
"format": "inline"
}
}
</templatedata>
</templatedata>
 
<includeonly>{{Sandbox other||
== Redirects ==
<!-- Categories below this line; interwikis at Wikidata -->
* {{tl|Confused}}
[[Category:Hatnote templates{{#translation:}}]]
* {{tl|Confuse}}
* {{tl|Misspelling}}
* {{tl|Nottobeconfusedwith}}
* {{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>
}}</includeonly>

Revision as of 08:43, 20 July 2022

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

Adds warning "Not to be confused" on the reader's page, with a short list of related pages.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Page 11

Full name of related page

Page namerequired
Label 1l1 label 1

Custom label for the link, instead of the page name.

Default
Page name
Lineoptional
Page 22

Full name of related page

Page nameoptional
Label 2l2 label 2

Custom label for the link, instead of the page name.

Default
Page name
Lineoptional
Page 33

Full name of related page

Page nameoptional
Label 3l3 label 3

Custom label for the link, instead of the page name.

Default
Page name
Lineoptional
Page 44

Full name of related page

Page nameoptional
Label 4l4 label 4

Custom label for the link, instead of the page name.

Default
Page name
Lineoptional
Retrieved from "https://www.thegoonshow.co.uk/wiki/index.php?title=Template:Distinguish/doc&oldid=337"