Module:Distinguish/en

From blackwiki
Jump to navigation Jump to search


Module documentation

Usage

Script error: No such module "Template link general". is used to create hatnotes to warn about possible confusion with a small number of other, related, titles at the top of article sections according to Wikipedia:Layout.

It is not for use in the "See also" section at the bottom of an article.

Script error: No such module "Template link general".
  • One to four articles can be listed.
  • The word "or" is always placed between the final two entries when displayed.
  • If more than 4 entries are supplied, a message will be displayed pointing out the problem.
  • You can use parameters label 1 to label 4 to specify alternative labels for the links.
Adding newline characters will break article links.

Examples

  • Script error: No such module "Template link general".
  • Script error: No such module "Template link general".
  • Script error: No such module "Template link general".
  • Script error: No such module "Template link general".
  • Script error: No such module "Template link general".
  • Script error: No such module "Template link general".


Description

The "distinguish" template produces a hatnote to point out to our readers the existence of one or more articles whose title(s) is/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

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"):

Script error: No such module "Template link general".


This hatnote can be used to distinguish the topic from multiple other topics:

Script error: No such module "Template link general".

Script error: No such module "Template link general".


It can also be used to customize the text that will appear. You may do this using the template's |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 piped:

Script error: No such module "Template link general".

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

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 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, Script error: No such module "Template link general". 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:

☒N 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 Script error: No such module "Template link general". instead of Script error: No such module "Template link general".. The difference is to provide explanatation upfront without requiring the reader to click through and differentiate the terms on their own.

checkY Reversi
Script error: No such module "about".

Script error: No such module "Template link general". 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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Distinguish

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

Pagesuggested
Optional additional article to link (2)2

Optional additional article to link

Pageoptional
Optional additional article to link (3)3

Optional additional article to link

Pageoptional
Optional additional article to link (4)4

Optional additional article to link

Pageoptional
Custom texttext

Custom message in wikitext; e.g. "[[foo]] and [[bar]]" produces "Not to be confused with [[foo]] and [[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