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 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 = ***}} .

Set index

See also category: Set index article templates

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:

{{Disambiguation|school|hospital}}

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

{{Disambiguation|human name}}: for Category:Human name disambiguation pages (note that you must instead add the category separately if it needs a different sort key)
{{Disambiguation|given name}}: Category:Disambiguation pages with given-name-holder lists
{{Disambiguation|surname}}: for Category:Disambiguation pages with surname-holder lists
{{Disambiguation|latin}}: for Category:Latin name disambiguation pages
{{Disambiguation|split}}: 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 }}.

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