Template:Dmbox/doc

This is the Dmbox ([D]isambiguation footer [m]essage [box]) metatemplate.

It is used to build disambiguation and set index article message boxes, such as Disambiguation and Ship index.

This template works similarly to Ambox and mostly uses the same parameters. The main differences are that this box uses the disambiguation style and only has two "type" settings.

Usage
Simple usage example:

Complex example:

Some other parameter combinations:

Parameters
List of all parameters:

type
 * If no type parameter is given the template defaults to type disambig.
 * disambig = Makes it so the disambig editintro is displayed when editing a page with this template on. (Means that this template internally sets the CSS id "disambigbox". The id is used by the javascript in MediaWiki:Common.js to determine if a page is a disambiguation page or not.) And adds Category:All disambiguation pages and Category:All article disambiguation pages.


 * setindex = Does not trigger the disambig editintro when editing a page. (Because this instead sets the CSS id "setindexbox".) And adds Category:All set index articles.

nocat
 * true = Stops this template from categorizing. Useful for tests and demonstrations. Dmbox templates should forward nocat, so they too have the option to suppress categories. Thus, it is recommended that Dmbox templates always add something similar to this:

image
 *  [No parameter]  = If no image parameter is given, the template uses the default disambig or setindex image, depending on the type parameter.
 * An image = Should be an image with usual wiki notation. 30px - 50px width are usually about right depending on the image height to width ratio. (Keep the width small; images in this template do not automatically shrink on mobile devices.) For example:
 * = Means that no image is used.
 * = Means that no image is used.

imageright
 * No parameter = If no imageright parameter is given then no image is shown on the right side.
 * An image = Should be an image with usual wiki notation. 30px - 50px width are usually about right depending on the image height to width ratio. (Keep the width small; images in this template do not automatically shrink on mobile devices.) For example:
 * Anything = Any other object that you want to show on the right side.
 * Anything = Any other object that you want to show on the right side.

text
 * The message body text. This message box has italic text as default, thus no need to manually set that.

Technical details
If you need to use special characters in the text parameter then you need to escape them like this:

. And now a pipe and end braces |}}. }} For more technical details see the talk page. Since this template works almost exactly like ambox, tmbox, imbox, cmbox and ombox their talk pages and related pages might also contain more details.