Teamplaid:Distinguish/documentation

Tuairisgeul - Description

It renders a hatnote to remind readers about the existence of one or more articles or elements whose title(s) is/are similar to this page. It is used in cases where the distinction between the title(s) is/are obvious that it does not need further explanation.

For cases where an explanation is required, use {{For}} and {{About}}. For use on category pages, the corresponding template is {{Category distinguish}}.

Ùsaid - Usage

It is the standard usage:

{{Distinguish|Foo}} →

Not to be confused with Foo.

This hatnote can be used to distinguish from multiple articles:

{{Distinguish|Foo|Bar}} →

Not to be confused with Foo or Bar.

{{Distinguish|Foo|Bar|Gaz}} →

Not to be confused with Foo, Bar, or Gaz.

You may customize the text too. Use |text=. For example:

{{Distinguish|text = custom [[text]], or [[foo]], a common example term}} →

Not to be confused with custom text, or foo, a common example term.

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

Not to be confused with 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, {{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:

N Reversi

Not to be confused with 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 {{About}} instead of {{Distinguish}}. The difference is to provide explanatation upfront without requiring the reader to click through and differentiate the terms on their own.

Y Reversi

This template is about the board game. For the card game, see Reversis.

{{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 avoid trivial uses.

Teamplaid-dàta - TemplateData

This is the WP:TemplateData documentation for this template used by WP:VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Distinguish

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

Paramadairean na teamplaide[Stiùirich an TemplateData]

Is fhearr leis an teamplaid seo fòrmatadh nam paramadairean am broinn na loidhne.

Paramadair		Tuairisgeul	Seòrsa	Staid
Name of article	1	Name of article that you want to link to	Duilleag	molta
Optional additional article to link (2)	2	Optional additional article to link	Duilleag	roghainneil
Optional additional article to link (3)	3	Optional additional article to link	Duilleag	roghainneil
Optional additional article to link (4)	4	Optional additional article to link	Duilleag	roghainneil
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[bar]]" produces "Not to be confused with [[foo]] and [[bar]]."	Sreang	roghainneil
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Booleach	roghainneil

Faic cuideachd - Also see

• {{About}}
• {{Category distinguish}}
• {{For}}
• {{Redirect}}
• {{R from misspelling}}