Modèle:Dmbox/doc

Message box
meta-templates
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

{{#ifeq:doc |doc

{{#ifeq:show |show

| <templatestyles src="Module:Message box/ombox.css"></templatestyles>

Modèle:Strong for Modèle:Terminate sentence
It contains usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Modèle |Utilisateur |modèle template page |{{#if:Modèle |modèle page|article}}}}}}}}.

        }}{{#if: |
         |   {{#ifexist:Modèle:Dmbox
                  | [[Category:{{#switch:Modèle |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  |
                 }}
        }}
    | 
   }}

This template is used on 443 000+ pages, or roughly 66417% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Erreur Lua dans Module:TNT à la ligne 159 : Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.

{{#switch:

 {{#if:
 | {{{demospace}}}    
 | {{#ifeq:Modèle|Modèle
   | template
   | other
   }}
 }}

| template = {{#ifeq:Dmbox/doc|Infobox||{{#ifeq:docdocd|Infobox|[[Category:Infobox templates|Modèle:Remove first word]]}}}} | other | #default = }}

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

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

Some text.

{{#if:|

{{{imageright}}}

}}

{{#switch:

| | disambig | setindex =

| #default =

This message box is using an invalid "type=" parameter and needs fixing.

}}{{#if:||{{#ifeq:|disambig|__DISAMBIG__|}}}}{{#switch: | setindex =

| disambig | #default =

}}

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

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:setindex
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

Some text.

{{#if:|

{{{imageright}}}

}}

{{#switch:setindex

| | disambig | setindex =

| #default =

This message box is using an invalid "type=setindex" parameter and needs fixing.

}}{{#if:||{{#ifeq:setindex|disambig|__DISAMBIG__|}}}}{{#switch:setindex | setindex =

| disambig | #default =

}}

Complex example:

{{dmbox
| type      = setindex
| image     = [[File:Schooner.svg|30px|link=|alt=]] [[File:DAB list gray.svg|30px|alt=Disambiguation icon]]
| text      = The message body text.
}}

{{#ifeq:

|none|

| {{#if:

|

 | [[File:{{#switch:setindex
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

The message body text.

{{#if:|

{{{imageright}}}

}}

{{#switch:setindex

| | disambig | setindex =

| #default =

This message box is using an invalid "type=setindex" parameter and needs fixing.

}}{{#if:||{{#ifeq:setindex|disambig|__DISAMBIG__|}}}}{{#switch:setindex | setindex =

| disambig | #default =

}}

Some other parameter combinations:

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

No type and no image given (default)

{{#if:|

{{{imageright}}}

}}

{{#switch:

| | disambig | setindex =

| #default =

This message box is using an invalid "type=" parameter and needs fixing.

}}{{#if:||{{#ifeq:|disambig|__DISAMBIG__|}}}}{{#switch: | setindex =

| disambig | #default =

}} <templatestyles src="Dmbox/styles.css" />

{{#ifeq:none|none|

| {{#if:none

|

none

 | [[File:{{#switch:
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

No type and image=none – No image is used and the text uses the whole message box area.

{{#if:|

{{{imageright}}}

}}

{{#switch:

| | disambig | setindex =

| #default =

This message box is using an invalid "type=" parameter and needs fixing.

}}{{#if:||{{#ifeq:|disambig|__DISAMBIG__|}}}}{{#switch: | setindex =

| disambig | #default =

}}

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:setindex
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

type = setindex
imageright = [[File:Schooner.svg|33px|link=|alt=]]

{{#if:

|

}}

{{#switch:setindex

| | disambig | setindex =

| #default =

This message box is using an invalid "type=setindex" parameter and needs fixing.

}}{{#if:||{{#ifeq:setindex|disambig|__DISAMBIG__|}}}}{{#switch:setindex | setindex =

| disambig | #default =

}}

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:setindex
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

This article includes a list of ships with the same or similar names. If an 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.

{{#if:

|

}}

{{#switch:setindex

| | disambig | setindex =

| #default =

This message box is using an invalid "type=setindex" parameter and needs fixing.

}}{{#if:||{{#ifeq:setindex|disambig|__DISAMBIG__|}}}}{{#switch:setindex | setindex =

| disambig | #default =

}}

Parameters

List of all parameters:

{{#ifeq:none / Fichier:Some image.svg|none|

| {{#if:none / Fichier:Some image.svg

|

none / Fichier:Some image.svg

 | [[File:{{#switch:disambig / setindex
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

The message body text.

{{#if:Fichier:Some image.svg|

Fichier:Some image.svg

}}

{{#switch:disambig / setindex

| | disambig | setindex =

| #default =

This message box is using an invalid "type=disambig / setindex" parameter and needs fixing.

}}{{#if:/ true||{{#ifeq:disambig / setindex|disambig|__DISAMBIG__|}}}}{{#switch:disambig / setindex | setindex =

| disambig | #default =

}} </syntaxhighlight>

|{{SAFESUBST:#if:type|type=}}

If no |{{SAFESUBST:#if:type|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.

|{{SAFESUBST:#if:nocat|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{{#switch:{{subst:substcheck}}

|¬=
|SUBST=

}}{{#if:when defined as?

|^{[{{#if:
 |{{{pre-text}}} 
}}when defined as?{{#if:
 | {{{post-text}}}
}}]}|

}} |{{SAFESUBST:#if:nocat|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|}}}

|{{SAFESUBST:#if:image|image=}}

[No parameter] = If no |{{SAFESUBST:#if:image|image=}} parameter is given, the template uses the default |{{SAFESUBST:#if:disambig|disambig=}} or |{{SAFESUBST:#if:setindex|setindex=}} image, depending on the |{{SAFESUBST:#if:type|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.

|{{SAFESUBST:#if:imageright|imageright=}}

No parameter = If no |{{SAFESUBST:#if:imageright|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.

|{{SAFESUBST:#if:text|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:

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}.

{{#if:|

{{{imageright}}}

}}

{{#switch:

| | disambig | setindex =

| #default =

This message box is using an invalid "type=" parameter and needs fixing.

}}{{#if:||{{#ifeq:|disambig|__DISAMBIG__|}}}}{{#switch: | setindex =

| disambig | #default =

}} </syntaxhighlight> <templatestyles src="Dmbox/styles.css" />

{{#ifeq:|none|

| {{#if:

|

{{{image}}}

 | [[File:{{#switch:
   | setindex = DAB list gray.svg
   | disambig      
   | #default = Disambig gray.svg
   }}|30px|alt=Disambiguation icon]]
 }}

}}

Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}.

{{#if:|

{{{imageright}}}

}}

{{#switch:

| | disambig | setindex =

| #default =

This message box is using an invalid "type=" parameter and needs fixing.

}}{{#if:||{{#ifeq:|disambig|__DISAMBIG__|}}}}{{#switch: | setindex =

| disambig | #default =

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

Modèle:Dmbox/doc

Sommaire

Usage

Parameters

Technical details

See also

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