View source for Template:Mbox/doc

<includeonly>{{Languages|Template:Mbox}}</includeonly>
{{Mbox templates}}
{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Message box}}
{{Uses TemplateStyles
| Module:Message box/ambox.css
| Module:Message box/cmbox.css
| Module:Message box/imbox.css
| Module:Message box/ombox.css
| Module:Message box/tmbox.css
}}
{{High-use|15,000}}

This is the {{tlx|mbox}} or '''multi namespace message box''' meta-template.

This meta-template is used to build message box templates that are used on several types of pages and thus need to change style depending on what page they are used on. Based on page type detected it uses one of {{tlx|ambox}}, {{tlx|tmbox}}, {{tlx|imbox}}, {{tlx|cmbox}} and {{tlx|ombox}}.

Note that this template should only be used for message boxes that really need to adapt their style. Most message boxes do not need this and should use one of {{tlx|ambox}}, {{tlx|tmbox}}, {{tlx|imbox}}, {{tlx|cmbox}} or {{tlx|ombox}} directly. Using those templates directly means that your template will look the same on its template page and at any other place you show it, which makes it clear on what kind of pages it is supposed to be used. It also gives you access to any extra features those templates offer, and it saves some server load.

== Usage ==
This template takes the same parameters as {{tlx|ambox}} and {{tlx|imbox}} etc. See full documentation there.

Some of the boxes this template calls only handles images of max 52px width, thus that limitation also applies to this template or you will get ugly padding problems.

== Demospace ==
This template optionally takes the "demospace" parameter to specify a namespace for testing and demonstration purposes. If you want to lock your message box to one style then instead use one of the other mboxes directly.

Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was updated to understand both names well before that, thus it still works fine. For backwards compatibility it still understands "demospace = image" which means the same thing as "demospace = file". But using "demospace = image" is now deprecated.

Namespace "Book:" was added to the English Wikipedia on 28 December 2009. This template uses the {{tlx|ombox}} style on "Book:" pages or when "demospace=book". And it uses the {{tlx|tmbox}} style on "Book talk:" pages or when "demospace=talk". Note that "demospace=talk" means any talk space, there is no "demospace=book talk".

== Parameters ==
List of all parameters:

<pre>
{{mbox
| demospace = {{{demospace|}}} / main / talk / file / category / other
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[File:Some image.svg|40px]]
| imageright = [[File:Some image.svg|40px]]
| style = CSS values
| textstyle  = CSS values
| text  = The message body text.
| small = {{{small|}}} / left / yes
| smallimage = none / [[Image:Some image.svg|30px]]
| smallimageright = none / [[Image:Some image.svg|30px]]
| smalltext  = A shorter message body text.
}}
</pre>

Note: The small parameters only have effect when the template is on an article, talk page or an "other" page. For documentation on the small parameters see {{tlx|ambox}}, {{tlx|tmbox}} and {{tlx|ombox}}. Using the small parameters when they are not valid has no effect, but also does no harm.

=== TemplateData ===
{{TemplateData header}}
<templatedata>
{
	"description": "This is the {{mbox}} or “multi namespace message box” meta-template.",
	"format": "block",
	"params": {
		"demospace": {
			"label": "Demo Namespace",
			"suggestedvalues": [
				"main",
				"talk",
				"file",
				"category",
				"other"
			],
			"type": "string"
		},
		"type": {
			"label": "Type",
			"suggestedvalues": [
				"speedy",
				"delete",
				"content",
				"style",
				"notice",
				"move",
				"protection"
			],
			"type": "string",
			"default": "notice",
			"suggested": true
		},
		"image": {
			"label": "Image (left)",
			"suggestedvalues": [
				"none"
			],
			"default": "Depends on the “type” parameter.",
			"suggested": true,
			"type": "content"
		},
		"imageright": {
			"label": "Image (right)",
			"type": "content"
		},
		"style": {
			"label": "CSS Style",
			"type": "string"
		},
		"textstyle": {
			"label": "Text CSS Style",
			"type": "string"
		},
		"text": {
			"label": "Text",
			"suggested": true,
			"type": "content"
		},
		"small": {
			"label": "Small?",
			"suggestedvalues": [
				"{{{small|}}}",
				"left",
				"yes",
				"1"
			],
			"default": "0",
			"type": "boolean"
		},
		"smallimage": {
			"label": "Small Image (left)",
			"suggestedvalues": [
				"none"
			],
			"default": "{{{image}}}",
			"type": "content"
		},
		"smallimageright": {
			"label": "Small Image (right)",
			"suggestedvalues": [
				"none"
			],
			"default": "{{{imageright}}}",
			"type": "content"
		},
		"smalltext": {
			"label": "Small Text",
			"default": "{{{text}}}",
			"type": "content"
		}
	}
}
</templatedata>

== Message boxes ==
{| class="wikitable"
! Template
! Description
|-
| {{tlx|ambox}}
| Article message box, identifies problems or issues with the article
|-
| {{tlx|cmbox}}
| Category message box, {{tlx|ambox}} for categories
|-
| {{tlx|imbox}}
| Image message box, {{tlx|ambox}} for file (image) pages
|-
| {{tlx|ombox}}
| Other pages message box, {{tlx|ambox}} for pages of the types User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces
|-
| {{tlx|tmbox}}
| Talk page message box, {{tlx|ambox}} for talk pages
|-
! colspan = 2 | The following templates are not called by Mbox
|-
| {{tlx|fmbox}}
| used in system messages
|}

== See also ==
* [[w:Wikipedia:Classes in Ambox]] – Describes how to use the ambox CSS classes directly in [[w:Help:Table|wikitables]] and [[w:HTML element#Tables|HTML tables]].
* [[w:Wikipedia:Manual of Style/Article message boxes]] – The style guideline for creating article message boxes.
* [[w:Wikipedia talk:Manual of Style/Article message boxes]] – For discussion about these matters.

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Mbox templates{{#translation:}}]]
}}</includeonly>