Difference between revisions of "Template:Disambiguation/doc"

From blackwiki
Jump to navigation Jump to search
imported>MSGJ
(update after move)
imported>Rich Farmbrough
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
{{high-risk| 130,000+ }}
+
{{High-risk| 130,000+ }}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{dabnav}}
+
{{Dabnav}}
This is the {{tl|disambiguation}} template.
+
This is the {{tl|Disambiguation}} template.
  
 
'''<big>Important: Please do not [[Wikipedia:Substitution|subst:]] this template.</big>'''
 
'''<big>Important: Please do not [[Wikipedia:Substitution|subst:]] this template.</big>'''
Line 10: Line 10:
  
 
=== Page title fix ===
 
=== Page title fix ===
In the event that the page title is causing an error, such as <span class="plainlinks">[http://en.wikipedia.org/w/index.php?title=%2A%2A%2A&oldid=171348746 what happened]</span> at ''[[***]]'', add the parameter: '''<code>{{para|page-title |<var> page title</var>}}</code>''' . Thus, the [[***]] page would use the syntax: '''<code><nowiki>{{disambiguation|page-title = ***}}</nowiki></code>''' .
+
In the event that the page title is causing an error, such as <span class="plainlinks">[http://en.wikipedia.org/w/index.php?title=%2A%2A%2A&oldid=171348746 what happened]</span> at ''[[***]]'', add the parameter: '''<code>{{para|page-title |<var> page title</var>}}</code>''' . Thus, the [[***]] page would use the syntax: '''<code><nowiki>{{Disambiguation|page-title = ***}}</nowiki></code>''' .
  
=== Variant templates ===
+
===Variant templates===
 
====Disambiguation====
 
====Disambiguation====
 
{{Category see also|Disambiguation message boxes}}
 
{{Category see also|Disambiguation message boxes}}
  
For disambiguation pages requiring cleanup, use {{tl|disambig-cleanup}}.
+
For disambiguation pages requiring cleanup, use {{tl|Disambig-cleanup}}.
  
 
More specific and alternative templates do exist, for disambiguation pages or set index articles whose entries are limited exclusively to items of a particular type:
 
More specific and alternative templates do exist, for disambiguation pages or set index articles whose entries are limited exclusively to items of a particular type:
Line 49: Line 49:
  
 
=== Parameters ===
 
=== Parameters ===
Sometimes there isn't a specific disambiguation template (see list above) that fits for a page, or the page has items in more than one of the above classes. Then use {{tl|disambiguation}} but with one or more parameters telling which categories to use. Up to ten parameters can be fed, and in any order, for example:
+
Sometimes there isn't a specific disambiguation template (see list above) that fits for a page, or the page has items in more than one of the above classes. Then use {{tl|Disambiguation}} but with one or more parameters telling which categories to use. Up to ten parameters can be fed, and in any order, for example:
  
 
:{{tlc|disambiguation|school|hospital}}
 
:{{tlc|disambiguation|school|hospital}}
Line 55: Line 55:
 
Only add a parameter if the disambiguation page has several items of that type.
 
Only add a parameter if the disambiguation page has several items of that type.
  
* {{tlx|disambiguation|human name}}: for [[:Category:Human name disambiguation pages]] (note that you must instead add the category separately if it needs a different [[WP:SORT|sort key]])
+
* {{tlx|Disambiguation|human name}}: for [[:Category:Human name disambiguation pages]] (note that you must instead add the category separately if it needs a different [[WP:SORT|sort key]])
* {{tlx|disambiguation|given name}}: [[:Category:Given names]]
+
* {{tlx|Disambiguation|given name}}: [[:Category:Given names]]
* {{tlx|disambiguation|surname}}: for [[:Category:Surnames]]
+
* {{tlx|Disambiguation|surname}}: for [[:Category:Surnames]]
* {{tlx|disambiguation|airport}}: for [[:Category:Airport disambiguation]]
+
* {{tlx|Disambiguation|airport}}: for [[:Category:Airport disambiguation]]
* {{tlx|disambiguation|callsign}}: for [[:Category:Broadcast call sign disambiguation pages]]
+
* {{tlx|Disambiguation|callsign}}: for [[:Category:Broadcast call sign disambiguation pages]]
* {{tlx|disambiguation|chinese}}: for [[:Category:Disambiguation pages with Chinese character titles]]
+
* {{tlx|Disambiguation|chinese}}: for [[:Category:Disambiguation pages with Chinese character titles]]
* {{tlx|disambiguation|church}}: for [[:Category:Church building disambiguation pages]]
+
* {{tlx|Disambiguation|church}}: for [[:Category:Church building disambiguation pages]]
* {{tlx|disambiguation|fish}}: for [[:Category:Fish common names]]
+
* {{tlx|Disambiguation|fish}}: for [[:Category:Fish common names]]
* {{tlx|disambiguation|genus}}: for [[:Category:Genus disambiguation pages]]
+
* {{tlx|Disambiguation|genus}}: for [[:Category:Genus disambiguation pages]]
* {{tlx|disambiguation|geo}}: for [[:Category:Place name disambiguation pages]]
+
* {{tlx|Disambiguation|geo}}: for [[:Category:Place name disambiguation pages]]
* {{tlx|disambiguation|hospital}}: for [[:Category:Hospital disambiguation pages]]
+
* {{tlx|Disambiguation|hospital}}: for [[:Category:Hospital disambiguation pages]]
* {{tlx|disambiguation|latin}}: for [[:Category:Latin name disambiguation pages]]
+
* {{tlx|Disambiguation|latin}}: for [[:Category:Latin name disambiguation pages]]
* {{tlx|disambiguation|letter number}}: for [[:Category:Letter-number combination disambiguation pages]]
+
* {{tlx|Disambiguation|letter number}}: for [[:Category:Letter-number combination disambiguation pages]]
* {{tlx|disambiguation|math}}: for [[:Category:Mathematical disambiguation]]
+
* {{tlx|Disambiguation|math}}: for [[:Category:Mathematical disambiguation]]
* {{tlx|disambiguation|molform}}: for [[:Category:Molecular formula disambiguation pages]] and [[:Category:Molecular formulas]]
+
* {{tlx|Disambiguation|molform}}: for [[:Category:Molecular formula disambiguation pages]] and [[:Category:Molecular formulas]]
* {{tlx|disambiguation|number}}: for [[:Category:Lists of ambiguous numbers]]
+
* {{tlx|Disambiguation|number}}: for [[:Category:Lists of ambiguous numbers]]
* {{tlx|disambiguation|plant}}: for [[:Category:Plant common names]]
+
* {{tlx|Disambiguation|plant}}: for [[:Category:Plant common names]]
* {{tlx|disambiguation|political}}: for [[:Category:Political party disambiguation pages]]
+
* {{tlx|Disambiguation|political}}: for [[:Category:Political party disambiguation pages]]
* {{tlx|disambiguation|road}}: for [[:Category:Lists of roads sharing the same title]]
+
* {{tlx|Disambiguation|road}}: for [[:Category:Lists of roads sharing the same title]]
* {{tlx|disambiguation|school}}: for [[:Category:Educational institution disambiguation]]
+
* {{tlx|Disambiguation|school}}: for [[:Category:Educational institution disambiguation]]
* {{tlx|disambiguation|split}}: for [[:Category:Disambiguation pages in need of being split]]
+
* {{tlx|Disambiguation|split}}: for [[:Category:Disambiguation pages in need of being split]]
  
Note that {{tl|disambiguation}} might not have parameters for all subcategories of [[:Category:Disambiguation pages]], then you have to manually add the category to the disambig page.
+
Note that {{tl|Disambiguation}} might not have parameters for all subcategories of [[:Category:Disambiguation pages]], then you have to manually add the category to the disambig page.
  
 
=== Redirects ===
 
=== Redirects ===
Line 88: Line 88:
  
 
=== Technical details ===
 
=== Technical details ===
Internally, this template uses {{tl|dmbox}}. That template categorises pages into [[:Category:All disambiguation pages]] and [[:Category:All article disambiguation pages]].
+
Internally, this template uses {{tl|Dmbox}}. That template categorises pages into [[:Category:All disambiguation pages]] and [[:Category:All article disambiguation pages]].
  
This template also uses {{tl|disambiguation/cat}} to handle the categorisation parameters, such as "hospital" and "school".
+
This template also uses {{tl|Disambiguation/cat}} to handle the categorisation parameters, such as "hospital" and "school".
  
 
=== See also ===
 
=== See also ===
* {{tl|dablink}} – Basic article hatnote, see [[Wikipedia:HATTEST]] for the full hatnote index.
+
* {{tl|Dablink}} – Basic article hatnote, see [[Wikipedia:HATTEST]] for the full hatnote index.
* {{tl|dn}} – Adds an inline "disambiguation needed" tag to an ambiguous link within an article, see [[Wikipedia:OTHERUSES]] for more.
+
* {{tl|Dn}} – Adds an inline "disambiguation needed" tag to an ambiguous link within an article, see [[Wikipedia:OTHERUSES]] for more.
  
 
<includeonly>
 
<includeonly>

Revision as of 10:54, 23 May 2011

This is the {{Disambiguation}} template.

Important: Please do not subst: this template.

This is a general-purpose template, to be placed at the bottom of any article that exists to help readers find other articles with the same or similar names. This concept is called disambiguation and is used with many common words, such as cross, life and work. This template automatically adds articles to the Category:Disambiguation pages.

Page title fix

In the event that the page title is causing an error, such as what happened at ***, add the parameter: |page-title = page title . Thus, the *** page would use the syntax: {{Disambiguation|page-title = ***}} .

Variant templates

Disambiguation

For disambiguation pages requiring cleanup, use {{Disambig-cleanup}}.

More specific and alternative templates do exist, for disambiguation pages or set index articles whose entries are limited exclusively to items of a particular type:

Set index

For set index articles:

Parameters

Sometimes there isn't a specific disambiguation template (see list above) that fits for a page, or the page has items in more than one of the above classes. Then use {{Disambiguation}} but with one or more parameters telling which categories to use. Up to ten parameters can be fed, and in any order, for example:

{{disambiguation|school|hospital}}

Only add a parameter if the disambiguation page has several items of that type.

Note that {{Disambiguation}} might not have parameters for all subcategories of Category:Disambiguation pages, then you have to manually add the category to the disambig page.

Redirects

The following redirect to this template:

Technical details

Internally, this template uses {{Dmbox}}. That template categorises pages into Category:All disambiguation pages and Category:All article disambiguation pages.

This template also uses {{Disambiguation/cat}} to handle the categorisation parameters, such as "hospital" and "school".

See also