Template:Dmbox/doc

Message box meta-templates
template	context
{{Ambox}}	article
{{Cmbox}}	category
{{Imbox}}	image
{{Tmbox}}	talk
{{Fmbox}}	footer / header
{{Ombox}}	other pages
{{Mbox}}	auto-detect
{{Asbox}}	article stub
{{Dmbox}}	disambiguation

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:

{{dmbox | text = Some text.}}

{{dmbox | type = setindex | text = Some text.}}

Complex example:

{{dmbox
| type      = setindex
| image     = [[File:Schooner.svg|30px|link=|alt=]] [[File:DAB list gray.svg|30px|alt=Disambiguation icon]]
| textstyle=color: red; font-weight: bold; font-style: normal;
| text      = The message body text.
}}

Some other parameter combinations:

Parameters

List of all parameters:

{{dmbox
| type  = disambig / setindex
| image = none / [[File:Some image.svg|40px|link=|alt=]]
| imageright = [[File:Some image.svg|40px|link=|alt=]]
| style=CSS values
| textstyle=CSS values
| text  = The message body text. 
| nocat = {{{nocat|}}} / true
}}

|type=

If no |type= parameter is given the template defaults to type <syntaxhighlight lang="text" class="" id="" style="" inline="1">disambig</syntaxhighlight>.

<syntaxhighlight lang="text" class="" id="" style="" inline="1">disambig</syntaxhighlight> = 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.

<syntaxhighlight lang="text" class="" id="" style="" inline="1">setindex</syntaxhighlight> = 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=

<syntaxhighlight lang="text" class="" id="" style="" inline="1">true</syntaxhighlight> = 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:

nocat = {{{nocat|}}}

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

image = [[File:Schooner.svg|30px|link=|alt=]]

none = 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:

imageright = [[File:Nuvola apps bookcase.png|40px|alt=Books icon]]

Anything = Any other object that you want to show on the right side.

|style=

Optional CSS values used by the entire message box table. Without quotation marks " " but with the ending semicolons ;. For example:

style=margin-bottom: 0.2em;

|textstyle=

Optional CSS values used by the text cell. For example:

textstyle=text-align: center;

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

{{dmbox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. 
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}

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.

See also

There are seven metatemplates in the Module:Message box family:

• {{Ambox}}, for messageboxes on article pages.
• {{Cmbox}}, for messageboxes on category pages.
• {{Imbox}}, for messageboxes on file (image) pages.
• {{Tmbox}}, for messageboxes on talk pages.
• {{Fmbox}}, for header and footer messageboxes.
• {{Ombox}}, for messageboxes on other types of page.
• {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.

Closely related metatemplates:

• {{Asbox}}, for messageboxes in article stubs.
• {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
• {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.

Templates intended to be used in conjunction with Mboxes:

• {{Ombox/shortcut}}, an alternative to {{Shortcut}} for use in Mbox templates

Other pages:

• Wikipedia:Disambiguation, which includes a section explaining set index articles.
• Wikipedia:WikiProject Disambiguation
• MediaWiki:Disambiguationspage, where all disambiguation message boxes should be listed to assist automatic tools' identification of disambiguation pages. Now also has a separate list with all set index message boxes, so some tools can know what pages are set index articles.
• {{Disambiguation}}, the generic disambiguation message box.
• {{Set index article}}, the generic set index article message box.