Template:Disambiguation/doc: Difference between revisions

Revision as of 17:53, 23 January 2011

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 100,000+ pages.

To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit.

Please consider discussing any changes on the talk page before implementing them.

This is the {{Disambig }} 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: {{disambig |page-title = ***}} .

Variant templates

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

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

{{Airport disambig }} for airports – Category:Airport disambiguation
{{Callsigndis }} – Category:Broadcast call sign disambiguation pages
{{Disambig-Chinese-char-title }} – 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 }}
{{Hospitaldis }} for hospitals or medical centers – Category:Hospital disambiguation pages
{{Letter disambig }} – Adds no special category but adds a Latin letter navbox.
{{Letter-NumberCombDisambig }} – Category:Letter-number combination disambiguation pages
{{Mathdab }} for mathematics titles – Category:Mathematical disambiguation
{{MolFormDisambig }} – Category:Molecular formula disambiguation pages and Category:Molecular formulas
{{Numberdis }} for numbers – Category:Lists of ambiguous numbers
{{Schooldis }} for educational institutions – Category:Educational institution disambiguation
{{Species Latin name disambiguation }} – Category:Latin name disambiguation pages
{{WP disambig }} for Wikipedia project and help pages associated with a given shortcut or title

For set index articles:

{{SIA }} 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 disambig template (see list above) that fits for a page, or the page has items in more than one of the above classes. Then use {{Disambig }} but with one or more parameters telling which categories to use. Up to ten parameters can be fed, and in any order. Like this:

{{disambig|school|hospital}}

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

{{disambig|human name}}: for Category:Human name disambiguation pages (note that you must instead add the category separately if it needs a different sort key)
{{disambig|given name}}: Category:Given names
{{disambig|surname}}: for Category:Surnames
{{disambig|airport}}: for Category:Airport disambiguation
{{disambig|callsign}}: for Category:Broadcast call sign disambiguation pages
{{disambig|chinese}}: for Category:Disambiguation pages with Chinese character titles
{{disambig|church}}: for Category:Church building disambiguation pages
{{disambig|fish}}: for Category:Fish common names
{{disambig|genus}}: for Category:Genus disambiguation pages
{{disambig|geo}}: for Category:Place name disambiguation pages
{{disambig|hospital}}: for Category:Hospital disambiguation pages
{{disambig|latin}}: for Category:Latin name disambiguation pages
{{disambig|letter number}}: for Category:Letter-number combination disambiguation pages
{{disambig|math}}: for Category:Mathematical disambiguation
{{disambig|molform}}: for Category:Molecular formula disambiguation pages and Category:Molecular formulas
{{disambig|number}}: for Category:Lists of ambiguous numbers
{{disambig|plant}}: for Category:Plant common names
{{disambig|political}}: for Category:Political party disambiguation pages
{{disambig|road}}: for Category:Lists of roads sharing the same title
{{disambig|school}}: for Category:Educational institution disambiguation
{{disambig|split}}: for Category:Disambiguation pages in need of being split

For pages that need clean-up use {{Disambig-cleanup }}, it understands the same parameters.

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

Alternative names

For those who can't remember how this template's name is abbreviated, the {{Disambiguation }}, {{Disamb }} and {{Dab }} templates all redirect to {{Disambig }}.

Technical details

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

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