Template:Distinguish/doc

From MMC
Jump to navigation Jump to search

Template:Redirect-distinguish Template:Documentation subpage Template:Tsh Template:High-use Template:Lua

This template produces a hatnote to point out to readers, who may have misspelled their desired title, the existence of one or more pages whose title(s) is, or are, similar to the current page. It is used in cases where the distinction between the titles is generally obvious and does not need further explanation.

For cases where an explanation is required, please use the templates Template:Tl and Template:Tl. For use on category pages, the corresponding template is Template:Tl.

Usage

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

Template:Demo-inline

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

Template:Demo-inline
Template:Demo-inline

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,Template:Clarify the article "Apollo" is linked to directly and a short explanation fills in the necessary context:

Template:Demo-inline

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:

Template:TickTemplate:NbspTemplate:Demo-inline

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

Template:CrossTemplate:NbspTemplate:Demo-inline

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

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:

Template:Cross 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

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

Template:TemplateData header

A hatnote used when there is an ambiguity in an article's title.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Name of article1

Name of article that you want to link to

Page namesuggested
Optional additional article to link (2)2

Optional additional article to link

Page nameoptional
Optional additional article to link (3)3

Optional additional article to link

Page nameoptional
Optional additional article to link (4)4

Optional additional article to link

Page nameoptional
Custom texttext

Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."

Stringoptional
Self referenceselfref

If set, marks note as being a self reference, to not be shown when content is reused

Booleanoptional

Redirects

See also

Template:Hatnote templates