Editing Template:Dmbox/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

{{mbox templates}}
This is the {{tl|dmbox}} or '''disambiguation footer message box''' meta-template.

It is used to build disambiguation and [[Wikipedia:Disambiguation#Set index articles|set index article]] boxes, such as {{tl|Disambiguation}} and {{tl|shipindex}}. 

This template works similarly to {{tl|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:

<pre>
{{dmbox | text = Some text.}}
</pre>

{{dmbox | text = Some text.}}

<pre>
{{dmbox | type = setindex | text = Some text.}}
</pre>

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


Complex example:

<pre>
{{dmbox
| type      = setindex
| image     = {{nowrap| [[Image:Shuttle.png|30px]] [[Image:DebugLog.png|30px]] }}
| textstyle = color: red; font-weight: bold; font-style: normal;
| text      = The message body text.
}}
</pre>

{{dmbox
| type      = setindex
| image     = {{nowrap| [[Image:Shuttle.png|30px]] [[Image:DebugLog.png|30px]] }}
| textstyle = color: red; font-weight: bold; font-style: normal;
| text      = The message body text.
}}


Some other parameter combinations:

{{dmbox
| text  = No type and no image given ('''default''')
}}
{{dmbox
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}

{{dmbox
| type = setindex
| imageright = [[Image:Shuttle.png|33px]] 
| text  = type = setindex <br> imageright = <nowiki>[[Image:Schooner.svg|33px]]</nowiki>
}}

{{dmbox
| type = setindex
| imageright = [[Image:Shuttle.png|33px]]
| text  = 
This article includes a [[Wikipedia:WikiProject Ships/Guidelines#Index pages|list of ships]] with the same or similar names. If an [[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|internal link]] for a specific ship referred you to this page, you may wish to change the link to point directly to the intended ship article, if one exists.
}}

=== Parameters ===
List of all parameters:

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

'''type'''
:If no '''type''' parameter is given the template defaults to type '''disambig'''.
:'''disambig''' = Makes it so the <nowiki>{{tl|disambig editintro}}</nowiki> 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 <nowiki>[[:Category:All disambiguation pages]]</nowiki> and <nowiki>[[:Category:All article disambiguation pages]]</nowiki>.

:'''setindex''' = Does ''not'' trigger the <nowiki>{{tl|disambig editintro}}</nowiki> when editing a page. (Because this instead sets the CSS id "setindexbox".) And adds <nowiki>[[:Category:All set index articles]]</nowiki>.

'''nocat'''
:'''true''' = Stops this template from categorizing. Useful for instance when only testing or demonstrating this template. Templates that use this template should forward '''nocat''', so they too understand nocat. So always add this:
::<code><nowiki>nocat = {{{nocat|}}}</nowiki></code>

'''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. (But the message box can handle images of any size.) For example:
::<code><nowiki>image = [[Image:Schooner.svg|30px]]</nowiki></code>
:'''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. (But the message box can handle images of any size.) For example:
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''style'''
:Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-bottom: 0.2em;</code>

'''textstyle'''
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = text-align: center;</code>

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

=== Technical details ===
This template currently uses hard coded styles and class names. Later it will only use CSS classes making it easier to skin. (In the meantime it can be skinned by using the "<code>!important</code>" keyword.)

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

<pre>
{{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 &lt;nowiki>}}&lt;/nowiki>. 
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
</div>
}}
</pre>

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


Internally, this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[wikipedia:Help:ParserFunctions|parser functions]] and special characters in parameters. 

Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their pages and related pages might also contain more details.

=== See also ===
Other pages:

* [[Wikipedia:Disambiguation]] – Also has a section explaining [[Wikipedia:Disambiguation#Set index articles|set index articles]].
* [[Wikipedia:WikiProject Disambiguation]]
* {{tl|Disambiguation}} – The generic disambiguation message box.