Template:Imbox/doc

{{#switch:<translate></translate> | = {{#if:{{#ifexpr: ( {{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:imbox/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|}}

    | 

{{#ifeq:show |show

|

        }}{{#if: |
         |   {{#ifexist:Template:Imbox
                  | [[Category:{{#switch:Template
                          | Template | Project = Template
                          | Module   = Module
                          | User     = User
                          | #default = MediaWiki
                      }} documentation pages{{#translation:}}]]
                  | [[Category:Documentation subpages without corresponding pages{{#translation:}}]]
                 }}
        }}
    | 
   }}

| #default=

 {{#switch:

| = {{#if:{{#ifexpr: ( {{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:imbox/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|}}

    | 

{{#ifeq:show |show

|

        }}{{#if: |
         |   {{#ifexist:Template:Imbox
                  | [[Category:{{#switch:Template
                          | Template | Project = Template
                          | Module   = Module
                          | User     = User
                          | #default = MediaWiki
                      }} documentation pages{{#translation:}}]]
                  | [[Category:Documentation subpages without corresponding pages{{#translation:}}]]
                 }}
        }}
    | 
   }}

| #default=

}} }}

This is the {{{{#ifeq:Template:Imbox|

 |

}}[[Special:MyLanguage/Template:imbox|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Imbox/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Imbox
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:imbox
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Imbox
     |Imbox
     |Template:imbox
   }}
   |Template:imbox
 }}

}}}}]]{{#ifeq:Template:Imbox|

 |

}} }} or image message box meta-template.

It is used to build message box templates for file (image) pages, such as {{{{#ifeq:Template:Cleanup-image|

 |

}}[[Special:MyLanguage/Template:cleanup-image|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Cleanup-image/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Cleanup-image
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:cleanup-image
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Cleanup-image
     |Cleanup-image
     |Template:cleanup-image
   }}
   |Template:cleanup-image
 }}

}}}}]]{{#ifeq:Template:Cleanup-image|

 |

}} }} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.

This template works almost exactly like {{{{#ifeq:Template:Ambox|

 |

}}[[Special:MyLanguage/Template:ambox|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Ambox/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Ambox
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:ambox
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Ambox
     |Ambox
     |Template:ambox
   }}
   |Template:ambox
 }}

}}}}]]{{#ifeq:Template:Ambox|

 |

}} }} and uses the same parameters.

Usage

Simple usage example:

{{imbox | text = Some text.}}

File:OOjs UI icon information-progressive.svgSome text.

Complex example:

{{imbox
| type      = style
| image     = [[Image:Emblem-question-yellow.svg|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

File:Emblem-question-yellow.svgThe message body text.

Image message box types

The following examples use different type parameters but use no image parameters thus they use the default images for each type.

File:OOjs UI icon clock-destructive.svgtype=speedy – Speedy deletion templates such as {{{{#ifeq:Template:Isd|

 |

}}[[Special:MyLanguage/Template:isd|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Isd/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Isd
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:isd
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Isd
     |Isd
     |Template:isd
   }}
   |Template:isd
 }}

}}}}]]{{#ifeq:Template:Isd|

 |

}} }}.

File:OOjs UI icon alert-destructive.svgtype=delete – Deletion templates such as {{{{#ifeq:Template:Ifd|

 |

}}[[Special:MyLanguage/Template:ifd|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Ifd/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Ifd
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:ifd
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Ifd
     |Ifd
     |Template:ifd
   }}
   |Template:ifd
 }}

}}}}]]{{#ifeq:Template:Ifd|

 |

}} }}.

File:OOjs UI icon notice-warning.svgtype=content – Major warnings and problems, such as {{{{#ifeq:Template:Non-free reduce|

 |

}}[[Special:MyLanguage/Template:non-free reduce|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Non-free reduce/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Non-free reduce
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:non-free reduce
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Non-free reduce
     |Non-free reduce
     |Template:non-free reduce
   }}
   |Template:non-free reduce
 }}

}}}}]]{{#ifeq:Template:Non-free reduce|

 |

}} }}.

File:Edit-clear.svgtype=style – Minor warnings and problems, such as {{{{#ifeq:Template:Cleanup-image|

 |

}}[[Special:MyLanguage/Template:cleanup-image|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Cleanup-image/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Cleanup-image
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:cleanup-image
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Cleanup-image
     |Cleanup-image
     |Template:cleanup-image
   }}
   |Template:cleanup-image
 }}

}}}}]]{{#ifeq:Template:Cleanup-image|

 |

}} }}.

File:OOjs UI icon information-progressive.svgtype=notice – Notices and messages of any kind, both permanent and temporary.

File:Merge-split-transwiki default.svgtype=move – Move and rename messages and proposals, such as {{{{#ifeq:Template:Rename media|

 |

}}[[Special:MyLanguage/Template:rename media|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Rename media/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Rename media
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:rename media
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Rename media
     |Rename media
     |Template:rename media
   }}
   |Template:rename media
 }}

}}}}]]{{#ifeq:Template:Rename media|

 |

}} }}.

File:Semi-protection-shackle-keyhole.svgtype=protection – Protection templates such as {{{{#ifeq:Template:Pp-protected|

 |

}}[[Special:MyLanguage/Template:pp-protected|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Pp-protected/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Pp-protected
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:pp-protected
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Pp-protected
     |Pp-protected
     |Template:pp-protected
   }}
   |Template:pp-protected
 }}

}}}}]]{{#ifeq:Template:Pp-protected|

 |

}} }} when shown on an image page.

File:Cscr-featured.svgtype=featured – Featured image templates such as {{{{#ifeq:Template:FeaturedPicture|

 |

}}[[Special:MyLanguage/Template:FeaturedPicture|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}FeaturedPicture/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |FeaturedPicture
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:FeaturedPicture
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:FeaturedPicture
     |FeaturedPicture
     |Template:FeaturedPicture
   }}
   |Template:FeaturedPicture
 }}

}}}}]]{{#ifeq:Template:FeaturedPicture|

 |

}} }}.

Other images

The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the image parameter to specify an image other than the default images.

File:Gnome-dev-camera.svgtype = style
image = [[Image:Gnome-dev-camera.svg|42px]]
This image is used for {{{{#ifeq:Template:Cleanup-image|

 |

}}[[Special:MyLanguage/Template:cleanup-image|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Cleanup-image/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Cleanup-image
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:cleanup-image
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Cleanup-image
     |Cleanup-image
     |Template:cleanup-image
   }}
   |Template:cleanup-image
 }}

}}}}]]{{#ifeq:Template:Cleanup-image|

 |

}} }}.

File:To Commons.svgtype = move
image = [[Image:To Commons.svg|52px]]
This image is used for {{{{#ifeq:Template:Copy to Wikimedia Commons|

 |

}}[[Special:MyLanguage/Template:copy to Wikimedia Commons|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Template|Template:}}Copy to Wikimedia Commons/Page display title/en

 |{{#ifexpr:{{#if:0|1|0}} and 10!=0
   |{{#ifeq:en|en
     |Copy to Wikimedia Commons
     |{{#if:
        |{{#ifeq:0|0
          |
          | 
        }}
        |{{#if:{{ Template:TNTN | nsp = 0 }}
          |{{ Template:TNTN | nsp = 0 }}
          |Template:copy to Wikimedia Commons
       }}
     }}
   }}
   |{{ Template:TNTN }}
 }}
 |{{#if:0
   |{{#if:Copy to Wikimedia Commons
     |Copy to Wikimedia Commons
     |Template:copy to Wikimedia Commons
   }}
   |Template:copy to Wikimedia Commons
 }}

}}}}]]{{#ifeq:Template:Copy to Wikimedia Commons|

 |

}} }}.

Special

Some other parameter combinations.

File:OOjs UI icon information-progressive.svgNo type and no image given (default)

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

Parameters

List of all parameters:

{{imbox
| type  = speedy / delete / content / style / notice / 
          move / protection / license / featured
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| textstyle = CSS value
| text  = The message body text.
| below = More text or another imbox.
}}

type

If no type parameter is given the template defaults to type notice. That means it gets a blue border.

image

No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.

An image = Should be an image with usual wiki notation. 40px - 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:

image = [[Image:Gnome-dev-camera.svg|40px]]

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. 40px - 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:

imageright = [[Image:Nuvola apps bookcase.png|40px]]

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

style

An optional CSS value used by the entire message box table. Without quotation marks " ". For example:

style = margin-bottom: 0.5em;

textstyle

An optional CSS value used by the text cell. For example:

textstyle = text-align: center;

text

The message body text.

below

A full width area below the images and text area. Can take a text or any kind of object, for instance another imbox:

below = {{imbox | type = content | text = This license tag is deprecated. }}

Technical details

Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was created long before that, and that is why it is named "imbox" as in "image message box".

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

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

File:OOjs UI icon information-progressive.svg

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

This template uses the imbox CSS classes in MediaWiki:Common.css for most of its looks, thus it is fully skinnable.

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 parser functions and special characters in parameters.

The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent png images. For those older browsers these png images have been modified so that the color of their default backgrounds match the background color of the template. The default background that MediaWiki renders for svg images is always white. This creates a white box around the images when displayed in older browsers.

For more technical details see the talk page. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below.

TemplateData

{{#switch:<translate></translate> |=

{{#if:{{safesubst:#switch: 1

|no
|n
|false
|0        = 
|         = 
|¬        = 
|yes
|y
|true
|1        = yes
|#default = yes

}}|{{#ifexpr:{{#if:Mbox/TemplateData|{{#ifeq:Template:Imbox/doc|{{#switch:

|#default = Mbox/TemplateData 
| = 
   {{#ifeq:  | 
     | Template:Mbox/TemplateData            
     | Mbox/TemplateData      
   }}

}}|0|1}}|not{{#ifexpr: ( {{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:imbox/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}}}}|

|#default = Mbox/TemplateData 
| = 
   {{#ifeq:  | 
     | Template:Mbox/TemplateData            
     | Mbox/TemplateData      
   }}

}}|<span style="" title="<translate nowrap> View this template</translate>">{{#if:|<translate> v</translate>|<translate> view</translate>}}]] · [[[:Template:Fullurl:]] <span style="" title="<translate nowrap> Discuss this template</translate>">{{#if:|<translate> d</translate>|<translate> talk</translate>}}]{{#if:|| · [{{fullurl:{{#switch:

|#default = Mbox/TemplateData 
| = 
   {{#ifeq:  | 
     | Template:Mbox/TemplateData            
     | Mbox/TemplateData      
   }}

}}|action=edit}} <span style="" title="<translate nowrap> Edit this template</translate>">{{#if:|<translate> e</translate>|<translate> edit</translate>}}]}}{{#if:1|]}}}}}} {{#if:||<translate> This is the [[<tvar name=1>Special:MyLanguage/Help:TemplateData</tvar>|TemplateData]] documentation for this template used by [[<tvar name=2>Special:MyLanguage/VisualEditor</tvar>|VisualEditor]] and other tools.</translate>}}

Imbox

{{#ifeq:doc|sandbox||{{#if:{{#ifexpr: (

{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:imbox/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|}}|[[Category:TemplateData documentation{{#translation:}}]]|[[Category:Templates using TemplateData{{#translation:}}]]}}}} | #default=

 {{#switch:

|=

{{#if:{{safesubst:#switch: 1

|no
|n
|false
|0        = 
|         = 
|¬        = 
|yes
|y
|true
|1        = yes
|#default = yes

}}|{{#ifexpr:{{#if:Mbox/TemplateData|{{#ifeq:Template:Imbox/doc|{{#switch:

|#default = Mbox/TemplateData 
| = 
   {{#ifeq:  | 
     | Template:Mbox/TemplateData            
     | Mbox/TemplateData      
   }}

}}|0|1}}|not{{#ifexpr: ( {{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:imbox/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}}}}|

|#default = Mbox/TemplateData 
| = 
   {{#ifeq:  | 
     | Template:Mbox/TemplateData            
     | Mbox/TemplateData      
   }}

}}|<span style="" title="<translate nowrap> View this template</translate>">{{#if:|<translate> v</translate>|<translate> view</translate>}}]] · [[[:Template:Fullurl:]] <span style="" title="<translate nowrap> Discuss this template</translate>">{{#if:|<translate> d</translate>|<translate> talk</translate>}}]{{#if:|| · [{{fullurl:{{#switch:

|#default = Mbox/TemplateData 
| = 
   {{#ifeq:  | 
     | Template:Mbox/TemplateData            
     | Mbox/TemplateData      
   }}

}}|action=edit}} <span style="" title="<translate nowrap> Edit this template</translate>">{{#if:|<translate> e</translate>|<translate> edit</translate>}}]}}{{#if:1|]}}}}}} {{#if:||This is the TemplateData documentation for this template used by VisualEditor and other tools.}}

Imbox

{{#ifeq:doc|sandbox||{{#if:{{#ifexpr: (

{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:imbox/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|}}|[[Category:TemplateData documentation{{#translation:}}]]|[[Category:Templates using TemplateData{{#translation:}}]]}}}} | #default=

}} }} <templatedata> { "description": {

"cs": "Toto je specializovaná verze metašablony

nebo “multi namespace message box“.", "en": "This is the specialized version of the

or \"multi-namespace message box\" meta-template.", "pt-br": "Esta é a versão especializada da meta-predefinição

, ou “caixa de mensagem para múltiplos espaços nominais”."

}, "format": "block", "params": { "type": { "label": { "en": "Type", "cs": "Typ", "pt-br": "Tipo" }, "suggestedvalues": [ "notice", "style", "content", "delete", "speedy", "protection", "move" ], "type": "string", "default": "notice", "suggested": true, "description": "Adjusts border and background for the appropriate use-case. Default notice is gray with a blue border.", "autovalue": "notice" }, "image": { "label": { "en": "Image (left)", "cs": "Obrázek (vlevo)", "pt-br": "Imagem (esquerda)" }, "suggestedvalues": [ "none" ], "default": { "en": "Depends on the “type” parameter.", "cs": "Závisí na parametru “type“.", "pt-br": "Depende do parâmetro “type”." }, "suggested": true, "type": "content" }, "imageright": { "label": { "en": "Image (right)", "cs": "Obrázek (vpravo)", "pt-br": "Imagem (direita)" }, "type": "content" }, "style": { "label": { "en": "CSS Style", "cs": "Styl CSS", "pt-br": "Estilo CSS" }, "type": "string" }, "textstyle": { "label": { "en": "Text CSS Style", "cs": "Textový styl CSS", "pt-br": "Estilo CSS para o texto" }, "type": "string" }, "text": { "label": { "en": "Text", "cs": "Text", "pt-br": "Texto" }, "suggested": true, "type": "content" }, "small": { "label": { "en": "Small?", "cs": "Malý?", "pt-br": "Caixa pequena?" }, "suggestedvalues": [ "", "left", "yes", "1" ], "default": "0", "type": "boolean" }, "smallimage": { "label": { "en": "Small Image (left)", "cs": "Malý obrázek (vlevo)", "pt-br": "Imagem da caixa pequena (esquerda)" }, "suggestedvalues": [ "none" ], "default": "{{{image}}}", "type": "content" }, "smallimageright": { "label": { "en": "Small Image (right)", "cs": "Malý obrázek (vpravo)", "pt-br": "Imagem da caixa pequena (direita)" }, "suggestedvalues": [ "none" ], "default": "{{{imageright}}}", "type": "content" }, "smalltext": { "label": { "en": "Small Text", "cs": "Malý text", "pt-br": "Texto da caixa pequena" }, "default": "{{{text}}}", "type": "content" } } } </templatedata>