Template:Disambiguation/doc

From Wikispooks
Jump to navigation Jump to search
Disambiguation

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

Variant templates

Disambiguation

See also: Category:Disambiguation message boxes.

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:

See also WP:SIA which includes a list of templates for set index articles.

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 from this list if the disambiguation page has several items of that type:

These can be added if there are one or more elements in the list (per their category descriptions):

These can be added even if there's only one element in the list, since these types are not actually ambiguous:

This parameter reflects the title, not the contents:

And this parameter reflects a maintenance need, not the contents:

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.

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:

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

Template use

Place template at the foot of the disambiguation page after all of the disambiguation content but before any categories (see below) or interlanguage links, as per WP:DCAT.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Disambiguation

<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
       }
   }

} </templatedata>

See also

Retrieved from "https://wikispooks.com/w/index.php?title=Template:Disambiguation/doc&oldid=61214"