Template:Distinguish: Difference between revisions
>Redrose64 join lines to fix usages in {{Documentation}} - green shading terminates early |
>Hog Farm Wikipedia:Templates for discussion/Log/2023 February 4#Template:Distinguish closed as keep (XFDcloser) |
||
| (26 intermediate revisions by 14 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{#invoke:Distinguish|distinguish}}<noinclude><!-- splitting these lines causes {{Documentation}} template to terminate green shading when Distinguish is used in /doc pages. --> | ||
{{Documentation}} | {{Documentation}} | ||
<!-- Add categories | <!-- Add categories to the /doc subpage and interwikis to Wikidata, not here! --> | ||
</noinclude> | </noinclude> | ||
Latest revision as of 21:16, 4 February 2023
| Warning | This template is used on approximately 116,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. |
Lua error in Module:Lua_banner at line 113: attempt to index field 'edit' (a nil value).
Description[edit]
The "distinguish" template produces a hatnote to point out to readers, who may have misspelled their desired title, 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 Template:tl and Template:tl. 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:
Template:tlx →This hatnote can be used to distinguish the topic from multiple other topics, as for Corundum or Bangala language:
Template:tlx → Template:tlx →The Template:para 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:
Template:tlx →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 Template:tlc:
checkTemplate:nbspTemplate:tlx →The escape is necessary, otherwise the template will read the next text as another topic:
☒Template:nbspTemplate:tlx →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:
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, Template:tlx 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:
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 Template:tlx instead of Template:tlc. The difference is to provide explanation upfront without requiring the reader to click through and differentiate the terms on their own.
- Template:tick Reversi
- This article is about the board game. For the card game, see Reversis.
Template:tlc 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]
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>
.svg){kind=link}
