Template:Distinguish/doc: Difference between revisions

(One intermediate revision by the same user not shown)

Line 6:

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

The "distinguish" template produces a [[wikipedia: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}}.

Line 18:

{{tlx|distinguish|Bangla language|Mbangala language|Ngala language}} → {{Distinguish|Bangla language|Mbangala language|Ngala language}}

The {{para|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 [[WP:NCDAB|parenthetical disambiguation]] in "Phobos (mythology)" is insufficient to disambiguate the two. Since it [[WP:HNR|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:

The {{para|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 [[wikipedia:WP:NCDAB|parenthetical disambiguation]] in "Phobos (mythology)" is insufficient to disambiguate the two. Since it [[wikipedia:WP:HNR|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:

{{tlx|distinguish|text {{=}} Phoebus, an epithet of the Greek god [[Apollo]]}} → {{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 <code><nowiki>...an [[epithet]] of the [[Greek]] god [[Apollo]].</nowiki></code>

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|!}}:

When the target is a disambiguation page, display of the parentheses may be avoided by escaping the vertical bar using the [[wikipedia:Help:Magic words|magic word]] {{Tl|!}}:

{{Tick}}{{tlx|distinguish|Crossfire (disambiguation){{!}}Crossfire}} → {{Distinguish|Crossfire (disambiguation){{!}}Crossfire}}

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

Line 45:

:: ''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]].

{{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 [[wikipedia:WP:TRHAT|avoid trivial uses]].

== TemplateData ==