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. |
[[Category:Template documentation pages{{#translation:}}]]
 | This template is used on approximately 220,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template should not be substituted. |
| This template adds an automatically generated short description via an embedded template. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
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 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
Disambiguation
For disambiguation pages requiring cleanup, use {{Disambiguation cleanup}}.
More specific and alternative templates exist for disambiguation pages whose entries are limited exclusively to items of a particular type:
Note: A set index article (SIA) is not a disambiguation page; it is a list article about a set of items of a specific type that also share the same (or similar) name. Wikipedia:Set index articles includes templates for SIAs.
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}}
This list is currently complete as of 28 October 2023[update] and {{Disambiguation}} has parameters for all subcategories of Category:Disambiguation pages; it is recommended to use this template and its parameters instead of adding that categories' subcategory to the disambiguation page manually.
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" as follows:
{{Disambiguation|nocat=true}}{{Disambiguation|nocat=yes}}
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".
Other templates and modules used:
- {{Disambiguation page short description}}
- {{Template other}}
- {{Title disambig text}}
- {{PAGENAMEBASE}}
- {{Trim}}
- {{Str rep}}
- {{#invoke:Redirect|isRedirect}}
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:DCAT guideline.
TemplateData
TemplateData for Disambiguation
<templatedata> { "description": "Place at the bottom of Disambiguation pages.", "params": { "1": { "label": "First category key", "description": "Used to put the page in a category. Can be one of 'split' (dab pages in need of being split); 'cleanup','clean up','clean-up' (dabs in need of cleanup); 'one non-primary topic','non-primary','non-primary topic' (dabs without a primary topic); 'functional area'", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ], "suggested": true }, "2": { "label": "Second category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "3": { "label": "Third category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "4": { "label": "Fourth category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "5": { "label": "Fifth category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "6": { "label": "Sixth category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "7": { "label": "Seventh category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "8": { "label": "Eighth category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "9": { "label": "Ninth category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "10": { "label": "Tenth category key", "description": "Further category keys, as parameter 1.", "type": "string", "required": false, "suggestedvalues": [ "split", "cleanup", "clean up", "clean-up", "one non-primary topic", "non-primary", "non-primary topic", "functional area" ] }, "hn": { "label": "Human name", "description": "Human name disambiguation page with its own sort key.", "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 }, "ignore_parentheses": { "label": "ignore_parentheses", "description": "Set to 'yes' to prevent parentheses in the article title from being parsed as incomplete disambiguation.", "type": "string", "required": false }, "type": { "label": "type", "description": "Manually specify the article type in the descriptive text ('This disambiguation page lists {{{type}}} articles...')", "type": "string", "required": false } } } </templatedata>
See also
- Wikipedia:Hatnote
- {{Dablinks}} – lists wikilinks on the page that link to disambiguation pages
- {{dabsearch}}
- {{Disambiguation needed}} – Adds an inline "disambiguation needed" tag to an ambiguous link within an article, see Wikipedia:OTHERUSES for more.
- {{WikiProject Disambiguation}} – for disambig talkpages
- {{Redirect}} – for linking to disambiguation pages in an article that is the primary topic of a redirect
- {{Other uses}} – for linking to disambiguation pages in articles