Template:Disambig/doc

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:  . Thus, the *** page would use the syntax:  .

Disambiguation
For disambiguation pages requiring cleanup, use Disambiguation 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:
 * Airport disambiguation for airports – Category:Airport disambiguation
 * Call sign disambiguation – Category:Broadcast call sign disambiguation pages
 * Chinese title disambiguation – Category:Disambiguation pages with Chinese character titles
 * Geodis for place names – Category:Place name disambiguation pages
 * Hndis for people's names – Category:Human name disambiguation pages
 * Hndis-cleanup
 * Hospital disambiguation for hospitals or medical centers – Category:Hospital disambiguation pages
 * Letter disambiguation – adds a Latin letter navbox, does not auto-categorize
 * Letter-NumberCombDisambig – Category:Letter-number combination disambiguation pages
 * Mathematical disambiguation for mathematics titles – Category:Mathematical disambiguation
 * Numberdis for numbers – Category:Lists of ambiguous numbers
 * School disambiguation for educational institutions – Category:Educational institution disambiguation pages
 * Species Latin name disambiguation – Category:Latin name disambiguation pages
 * Wikipedia disambiguation for ambiguous titles and shortcuts in the Wikipedia namespace – Category:Wikipedia project disambiguation pages

Set index
For set index articles:


 * Set index article for any set index article – Category:Set indices
 * Mountainindex for mountain names – Category:Set indices on mountains
 * Roadindex for roads, streets, or highways – Category:Lists of roads sharing the same title
 * Shipindex for ship names – Category:Set indices on ships
 * Sportindex for sport names – Category:Set indices on sports
 * Surname for people's surnames – Category:Surnames
 * Given name for people's given names – Category:Given names

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:



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


 * : for Category:Human name disambiguation pages (note that you must instead add the category separately if it needs a different sort key)
 * : Category:Disambiguation pages with given-name-holder lists
 * : for Category:Disambiguation pages with surname-holder lists
 * : for Category:Airport disambiguation
 * : for Category:Broadcast call sign disambiguation pages
 * : for Category:Disambiguation pages with Chinese character titles
 * : for Category:Church building disambiguation pages
 * : for Category:Fish common name disambiguation pages
 * : for Category:Genus disambiguation pages
 * : for Category:Place name disambiguation pages
 * : for Category:Hospital disambiguation pages
 * : for Category:Latin name disambiguation pages
 * : for Category:Letter-number combination disambiguation pages
 * : for Category:Mathematical disambiguation
 * : for Category:Lists of ambiguous numbers
 * : for Category:Plant common name disambiguation pages
 * : for Category:Political party disambiguation pages
 * : for Category:Lists of roads sharing the same title
 * : for Category:Educational institution disambiguation pages
 * : for Category:Disambiguation pages in need of being split

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:


 * Disambig
 * Dab
 * DAB
 * Disamb

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

TemplateData
{   "description": "Place at the bottom of Disambiguation pages.", "params": { "1": {           "label": "1", "description": "Used to put the page in a category. Can be one of 'split' (dab pages in need of being split); 'clean up','clean-up','cleanup' (dabs in need of cleanup); 'airports','airport' (airport dabs); 'call sign','call signs','broadcast call sign','broadcast call signs','callsign' (broadcast call sign dabs); 'chinese char','chinese-char','chinesechar','chinese character','chinese' (chinese character dabs); 'churches','church building','church buildings','church' (church building dabs), 'fish' (fish dabs); 'geodis','geography','geographical','place name','place names','place','places','geo' (Place names); 'county'; 'uscounty' (United States county dabs); 'township' (Township name dabs); 'name','names','human name','human names','hn','hndis' (Human name dabs); 'surnames','surname' (surname dabs); 'given names','given name' (given-name dabs), 'hospital name','hospital names','hospitals','hospital' (hospital dabs); 'latin name','latin names','latin' (Latin name dabs); 'letter-number','letter number' (Letter-number combination dabs); 'mathdab','maths','mathematics','mathematical','math' (mathematical dabs); 'numberdis','numbers','ambiguous number','ambiguous numbers','number' (Lists of ambiguous numbers), 'plants','plant' (Plant common name dabs); 'roaddis','roads','road' (road dabs), 'schooldis','schools','educational institution','educational institutions','college','colleges','university','universities','school' (Educational institution dabs); 'political','party' (political party dabs), 'genus' (Genus dabs)", "type": "string", "required": false },       "2": {            "label": "2", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "3": {            "label": "3", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "4": {            "label": "4", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "5": {            "label": "5", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "6": {            "label": "6", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "7": {            "label": "7", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "8": {            "label": "8", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "9": {            "label": "9", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "10": {            "label": "10", "description": "Further category keys, as parameter 1.", "type": "string", "required": false },       "page-title": { "label": "page-title", "description": "Page title to use, only useful for special cases when default does not work.", "type": "string", "default": "(FULLPAGENAME)", "required": false },       "nocat": { "label": "nocat", "description": "Set to 'yes' to prevent categorisation.", "type": "string", "required": false },       "demospace": { "label": "demospace", "description": "Used for testing.", "type": "string", "required": false }   } }