Template:Disambiguation/doc
 | This is a documentation subpage for Template:Disambiguation. It contains usage information, categories and other content that is not part of the original Template page. |
This is the {{Disambiguation}} 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 wp:work. This template automatically adds articles to the Category:Disambiguation pages.
Page title fixes
This template will automatically detect incomplete disambiguation present in page titles. If the title includes anything other than (disambiguation) in parentheses, it is assumed to be the article type. For example, this template on the page 1st Division (France) would produce the text "This disambiguation page lists France articles associated with the title 1st Division". If the page title contains parentheses that are not used for disambiguation (such as Everything You Always Wanted to Know About Sex* (*But Were Afraid to Ask)), set |ignore_parentheses=yes. If you wish to manually specify the article type, use the |type= parameter.
Variant templates
Parameters
You can use {{Disambiguation}} with one or more parameters telling which categories to use to make the disambiguation clearer. Up to ten parameters can be fed, and in any order. For example:
{{Disambiguation|school|hospital}}
Note that {{Disambiguation}} might not have parameters for all subcategories of Category:Disambiguation pages; the category may have to be manually added to the disambiguation page.
Nocat
If categorization is not needed on pages that are not in mainspace, then the "nocat" parameter may be set equal to "true" or "yes".
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 categorization parameters, such as "hospital" and "school".
Other templates and modules used:
- {{Template other}}
- {{Title disambig text}}
- {{PAGENAMEBASE}}
- {{Trim}}
- {{Str rep}}
Template use
Place template at the foot of the disambiguation page after all of the disambiguation content but before any categories (see below) (interlanguage links to Wikidata), as per the wp:WP:DCAT guideline.
TemplateData
Place at the bottom of Disambiguation pages.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | 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) | String | optional |
| 2 | 2 | Further category keys, as parameter 1. | String | optional |
| 3 | 3 | Further category keys, as parameter 1. | String | optional |
| 4 | 4 | Further category keys, as parameter 1. | String | optional |
| 5 | 5 | Further category keys, as parameter 1. | String | optional |
| 6 | 6 | Further category keys, as parameter 1. | String | optional |
| 7 | 7 | Further category keys, as parameter 1. | String | optional |
| 8 | 8 | Further category keys, as parameter 1. | String | optional |
| 9 | 9 | Further category keys, as parameter 1. | String | optional |
| 10 | 10 | Further category keys, as parameter 1. | String | optional |
| hn | hn | Human name disambiguation page with its own sort key. | String | optional |
| page-title | page-title | Page title to use, only useful for special cases when default does not work.
| String | optional |
| nocat | nocat | Set to 'yes' to prevent categorisation. | String | optional |
| demospace | demospace | Used for testing. | String | optional |
| ignore_parentheses | ignore_parentheses | Set to 'yes' to prevent parentheses in the article title from being parsed as incomplete disambiguation. | String | optional |
| type | type | Manually specify the article type in the descriptive text ('This disambiguation page lists {{{type}}} articles...') | String | optional |
See also