Template:Mbox/doc
This is a documentation subpage for Template:Mbox It may contain usage information, categories and other content that is not part of the original template page. |
This template is used in system messages. Changes to it can cause immediate changes to the Wikibooks user interface. To avoid major disruption, 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. Please discuss changes on the talk page before implementing them. |
This template is used on 10,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This is the {{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 {{ambox}}, {{tmbox}}, {{imbox}}, {{cmbox}} and {{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 {{ambox}}, {{tmbox}}, {{imbox}}, {{cmbox}} or {{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
[edit source]This template takes the same parameters as {{ambox}} and {{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
[edit source]This template optionally takes the "demospace" parameter as described at {{namespace detect}}. That parameter is only 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.
This template uses the {{ambox}} style on "Wikijunior:" and "Cookbook:" pages or when "demospace=wikijunior" or when "demospace=cookbook". And it uses the {{tmbox}} style on "Wikijunior talk:" and "Cookbook talk:" pages or when "demospace=talk". Note that "demospace=talk" means any talk space, there is no "demospace=wikijunior talk" or "demospace=cookbook talk".
Parameters
[edit source]List of all parameters:
{{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 / [[File:Some image.svg|30px]] | smallimageright = none / [[File:Some image.svg|30px]] | smalltext = A shorter message body text. }}
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 {{ambox}}, {{tmbox}}, and {{ombox}}. Using the small parameters when they are not valid has no effect, but also does no harm.
See also
[edit source]There are several meta-templates in the mbox family:
- {{ambox}} – For article message boxes.
- {{tmbox}} – For talk page message boxes.
- {{imbox}} – For file (image) page message boxes.
- {{cmbox}} – For category message boxes.
- {{ombox}} – For other pages message boxes.
- {{mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.
Closely related meta-templates:
- {{fmbox}} – For header and footer message boxes.