Template:Disambig3/doc: Difference between revisions

From MediaWiki
Jump to navigationJump to search
mNo edit summary
Tigerpaw28 (talk | contribs)
New documentation format
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
==Description==
Use this template at the top of an article when there are ''three or more uses'' for the term in question in order to link to the term's disambiguation page.
Use this template at the top of an article when there are ''three or more uses'' for the term in question in order to link to the term's disambiguation page.


Note - If two uses are more closely associated or far more prominent than the others, consider using {{tl|Disambig3.5}} instead.
==Usage==
===Parameters===
This template accepts three parameters, all anonymous.
====Required====
# The disambiguated term.
====Optional====
<ol>
<li value="2">The second term to be disambiguated. Takes precedence over term one when generating the link to the disambiguation page.</li>
<li value="3">Changes the format to the "about" version and should contain the description of what the article is about. Can also be specified as the named parameter "about"</li>
</ol>
===Code===
For basic use,
For basic use,
:<nowiki>{{Disambig3|Cybertron}}</nowiki>,
:'''<nowiki>{{Disambig3|Cybertron}}</nowiki>''',
generates
generates
{{Disambig3|Cybertron}}
{{Disambig3|Cybertron}}


If the root word of the disambiguation page is different from the word in the title of the current article (e.g., a different form of the same name like Bill/William), add a second argument to match the location of the disambiguation page. I.e,  
If the root word of the disambiguation page is different from the word in the title of the current article (e.g., a different form of the same name like Bill/William), add a second argument to match the location of the disambiguation page. I.e,  
:<nowiki>{{Disambig3|Bill|William}}</nowiki>
:'''<nowiki>{{Disambig3|Bill|William}}</nowiki>'''


on [[William Lennox]] gives:
on [[William Lennox]] gives:
Line 15: Line 33:
To describe the current article as in {{tl|disambig2}}, use the |about= variable like so:
To describe the current article as in {{tl|disambig2}}, use the |about= variable like so:


:<nowiki>{{Disambig3|The Transformers|about=the first issue of the Marvel US comic}}</nowiki>
:'''<nowiki>{{Disambig3|Transformers|The Transformers|about=the first comic issue of the first comic series about Transformers}}</nowiki>'''


which gives:
which gives:
{{Disambig3|The Transformers|about=the first comic issue of the first comic series about Transformers}}
{{Disambig3|Transformers|The Transformers|about=the first comic issue of the first comic series about Transformers}}
 
 
==Examples==
===Code===
<pre>{{disambig3|Cybertron}}</pre>
===Result===
{{disambig3|Cybertron}}
 
===Code===
<pre>{{Disambig3|Transformers|The Transformers|the first comic issue of the first comic series about Transformers}}</pre>
===Result===
{{Disambig3|Transformers|The Transformers|the first comic issue of the first comic series about Transformers}}


Note - if two uses closely associated or far more prominent than the others, consider using {{tl|Disambig3.5}} instead.
===Code===
<pre>{{disambig3|James|Jimmy}}</pre>
===Result===
{{disambig3|James|Jimmy}}


==See also==
==See also==
Line 27: Line 60:
* [[Template:Disambig3.5]]
* [[Template:Disambig3.5]]
* [[Template:Disambigr]]
* [[Template:Disambigr]]
* [[Template:Disambigm]]
<noinclude>[[Category:Externalized documentation]]</noinclude>
<noinclude>[[Category:Externalized documentation]]</noinclude>

Latest revision as of 01:50, 13 June 2022

Description

[edit]

Use this template at the top of an article when there are three or more uses for the term in question in order to link to the term's disambiguation page.

Note - If two uses are more closely associated or far more prominent than the others, consider using {{Disambig3.5}} instead.

Usage

[edit]

Parameters

[edit]

This template accepts three parameters, all anonymous.

Required

[edit]
  1. The disambiguated term.

Optional

[edit]
  1. The second term to be disambiguated. Takes precedence over term one when generating the link to the disambiguation page.
  2. Changes the format to the "about" version and should contain the description of what the article is about. Can also be specified as the named parameter "about"

Code

[edit]

For basic use,

{{Disambig3|Cybertron}},

generates

The name or term "Cybertron" refers to more than one character or idea. For a list of other meanings, see Cybertron (disambiguation).

If the root word of the disambiguation page is different from the word in the title of the current article (e.g., a different form of the same name like Bill/William), add a second argument to match the location of the disambiguation page. I.e,

{{Disambig3|Bill|William}}

on William Lennox gives:

The name or term "William" refers to more than one character or idea. For a list of other meanings, see Bill (disambiguation).

To describe the current article as in {{disambig2}}, use the |about= variable like so:

{{Disambig3|Transformers|The Transformers|about=the first comic issue of the first comic series about Transformers}}

which gives:

This article is about the first comic issue of the first comic series about Transformers. For other uses of "The Transformers", see Transformers (disambiguation)


Examples

[edit]

Code

[edit]
{{disambig3|Cybertron}}

Result

[edit]
The name or term "Cybertron" refers to more than one character or idea. For a list of other meanings, see Cybertron (disambiguation).

Code

[edit]
{{Disambig3|Transformers|The Transformers|the first comic issue of the first comic series about Transformers}}

Result

[edit]
This article is about the first comic issue of the first comic series about Transformers. For other uses of "The Transformers", see Transformers (disambiguation)

Code

[edit]
{{disambig3|James|Jimmy}}

Result

[edit]
The name or term "Jimmy" refers to more than one character or idea. For a list of other meanings, see James (disambiguation).

See also

[edit]