Difference between revisions of "Category:Citation templates that wrap CS1 templates"

These are tracking categories for Citation Style 1 templates that use Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other Template:Redirect-distinguishLua error: expandTemplate: template "No redirect" does not exist.

The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing the template name as code rather than actually invoking it. Its primary use is in instruction and documentation where it is used to refer to a template by name without invoking it.

Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results. This is not true for all such visually confusing templates containing a possible 1/l mix-up: and are not interchangeable.

Template loop detected: Template:Tl works exactly like Template loop detected: Template:Tl with the addition of optionally displaying alternative label text (link label). Template loop detected: Template:Tl can include the use of parameters in the template (as {{{1}}}).

Examples

A short example of its use is:

{{tl|Example}}

which generates

Template loop detected: Template:Tl

Other longer examples:

Code	Result	Notes
{{tl|Void}}	Template loop detected: Template:Tl	Standard usage
{{tls|Example}}	Template:Tls	For templates that should be substituted
{{tl2|X1}}	Template:Tl2	This formats the link to show how it would look in code (i.e., monospace font)
{{tl2|sisterTemplate:=M:|3x}}	{{3x}}	Same as above, for templates on another Wikimedia project (in this example, Meta, using m:). See Interwiki codes.
{{tl2|sisterTemplate:=wikibooks|langTemplate:=de:|WP}}	{{WP}}	For templates on another language project
{{tl|1==)}}	Template loop detected: Template:Tl	Use the format {{tl|1=templatename}} if the template contains template coding characters such as Template loop detected: Template:Tl or Template loop detected: Template:Tl

TemplateData

Template:Template other

This template displays a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.

Template parameters

Parameter		Description	Type	Status
template name	1	positional parameter: the template name without the namespace prefix “Template:”, which is added automatically	Line	required

See also

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other to produce a [t]emplate [l]ink with single [p]arameter.

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other to produce a [t]emplate [l]ink with e[x]tended number of parameters.

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other to produce a [t]emplate [l]ink that's [s]ubst:ituted, with a single [p]arameter.

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other

• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other, tl or tlp in any namespace.

• Template:Lcs
• Template loop detected: Template:Documentation subpage

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua: Module:distinguish

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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl.

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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish

This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish

It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish

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

Template loop detected: Template:Distinguish

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:

Template:Cross Reversi

Template loop detected: Template:Distinguish

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.

Template:Tick Reversi

Template:About

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

TemplateData

Template:Template other

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Name of article	1	Name of article that you want to link to	Page name	suggested
Optional additional article to link (2)	2	Optional additional article to link	Page name	optional
Optional additional article to link (3)	3	Optional additional article to link	Page name	optional
Optional additional article to link (4)	4	Optional additional article to link	Page name	optional
Custom text	text	Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]."	String	optional
Self reference	selfref	If set, marks note as being a self reference, to not be shown when content is reused	Boolean	optional

Redirects

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

See also

• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl
• Template loop detected: Template:Tl

Template:Hatnote templates

Template:Sandbox other This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}

or

{{Documentation subpage|[[Template:Var]]}}

Template:Example needed

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}

or

{{Userbox documentation subpage|[[Template:Var]]}}

Text customization

The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end

Other parameters

Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

• On a /doc page, it displays a box explaining template documentation and links to the template page.
• On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link
• Template loop detected: Template:Template link

Template:Sandbox other

Template:Big

Usage

File:Question book-new.svg

This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it.

Template:Dated maintenance category

Template:Confusing

See also

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Tiw
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other to e[xp]an[d] (i.e. demonstrate) a template in situ.

Template:Navbar

General-purpose formatting

Template:NoteFoot Template:Clear

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Template:Ml	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{mlx|Example|hello}}	Template:Mlx	Counterpart to Template loop detected: Template:Tl for linking to Lua modules
{{para|title|<var>book title</var>}}	Template:Para	Formats template parameters for display, with or without values
{{sclx|LASTING}}	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE|Template:Tag]] tag.
{{tag|ref}} {{xtag|templatedata}}	Template:Tag Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to Template loop detected: Template:Tl
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Template:Pf Template:Pf	Parser function equivalent to Template loop detected: Template:Tl
{{magic word|uc:}}	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tim|Hatnote}}	Template:Tim
{{tiw|Hatnote}}	Template loop detected: Template:Documentation subpage This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's or subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. This template uses Lua: Module:distinguish 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 Template loop detected: Template:Tl and Template loop detected: Template:Tl. For use on category pages, the corresponding template is Template loop detected: Template:Tl. 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"): {{distinguish|Foo}} → Template loop detected: Template:Distinguish This hatnote can be used to distinguish the topic from multiple other topics: {{distinguish|Foo|Bar}} → Template loop detected: Template:Distinguish {{distinguish|Foo|Bar|Gaz}} → Template loop detected: Template:Distinguish It can also be used to customize the text that will appear. You may do this using the template's Template:Para 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: {{distinguish|text Template:= the Martian moon [[Phobos (moon)|Phobos]], or Phoebus, an epithet of the Greek god [[Apollo]]}} → Template loop detected: Template:Distinguish 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 Template loop detected: Template:Distinguish 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: Template:Cross Reversi Template loop detected: Template:Distinguish 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. Template:Tick Reversi Template:About {{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. TemplateData This is the TemplateData documentation for this template used by VisualEditor and other tools; click here to see a monthly parameter usage report for this template. TemplateData for Citation templates that wrap CS1 templates Template:Template other A hatnote used when there is an ambiguity in an article's title. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status Name of article 1 Name of article that you want to link to Page name suggested Optional additional article to link (2) 2 Optional additional article to link Page name optional Optional additional article to link (3) 3 Optional additional article to link Page name optional Optional additional article to link (4) 4 Optional additional article to link Page name optional Custom text text Custom message in wikitext; e.g. "[[foo]] and [[Bar (computer science)|bar]]" produces "Not to be confused with [[foo]] and [[Bar (computer science)|bar]]." String optional Self reference selfref If set, marks note as being a self reference, to not be shown when content is reused Boolean optional Redirects Template loop detected: Template:Tl Template loop detected: Template:Tl Template loop detected: Template:Tl See also Template loop detected: Template:Tl Template loop detected: Template:Tl Template loop detected: Template:Tl Template loop detected: Template:Tl Template loop detected: Template:Tl Template:Hatnote templates Template:Sandbox other This template displays a message that the current page is a documentation subpage. Usage {{Documentation subpage}} or {{Documentation subpage|[[Template:Var]]}} Template:Example needed Userbox documentation To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use: {{Userbox documentation subpage}} or {{Userbox documentation subpage|[[Template:Var]]}} Text customization The parameters Template:Para and/or Template:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}} Template loop detected: Template:Documentation subpage Template:Hidden end Other parameters Template:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.) Display This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed: On a /doc page, it displays a box explaining template documentation and links to the template page. On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template loop detected: Template:Template link) will automatically note that the documentation is transcluded from a subpage. Functions In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F". See also Template loop detected: Template:Template link Template loop detected: Template:Template link Template loop detected: Template:Template link Template loop detected: Template:Template link Template loop detected: Template:Template link Template:Sandbox other Template:Big Usage File:Question book-new.svg This template's documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help to expand and improve it. Template:Dated maintenance category Template:Confusing See also Template loop detected: Template:Template-linking templates Template:Sandbox other
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

Template:Sandbox other.