Template:Mbox/doc: Difference between revisions
Template page
More actions
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
<!-- Please add categories at the bottom of this page, and interwikis at Wikidata (see Wikipedia:Wikidata) --> | |||
{{Cascade-protected template}} | |||
{{Lua|Module:Message box}} | |||
{{Mbox templates (small)}} | |||
{{tl|Mbox}} stands for '''M'''ulti-namespace message'''box''', a [[WP:MTM|metatemplate]] with which [[Wikipedia:Namespace|namespace]]-sensitive {{cl|Mbox and messagebox templates|messagebox templates}} can be implemented. | |||
The most common are {{tl|Ambox}} for articles, {{tl|Tmbox}} for talk pages, {{tl|Imbox}} for file (formerly image) pages, {{tl|Cmbox}} for category pages and {{tl|Ombox}} for other types of page. | |||
== Usage == | == Usage == | ||
This template | 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 the varieties just listed. 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. | ||
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. | This template takes the same parameters as {{tl|Ambox}}, {{tl|Imbox}}, etc. 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. | ||
== | === Parameters === | ||
List of all parameters: | List of all parameters: | ||
<syntaxhighlight lang="wikitext"> | |||
<syntaxhighlight lang=wikitext> | {{Mbox | ||
{{ | | name = name of the template | ||
| demospace = {{{demospace|}}} / main / talk / file / category / other | | demospace = {{{demospace|}}} / main / talk / file / category / other | ||
| type = speedy / delete / content / style / notice / move / protection | | type = speedy / delete / content / style / notice / move / protection | ||
| image = none / [[File:Some image.svg|40px]] | | image = none / [[File:Some image.svg|40px]] | ||
| imageright = [[File:Some image.svg|40px]] | | imageright = [[File:Some image.svg|40px]] | ||
| style = CSS values | | style=CSS values | ||
| textstyle | | textstyle=CSS values | ||
| text = The message body text. | | text = The message body text. | ||
| small = {{{small|}}} / left / | | small = {{{small|left}}} / left / no | ||
| smallimage = none / [[ | | smallimage = none / [[File:Some image.svg|30px]] | ||
| smallimageright = none / [[ | | smallimageright = none / [[File:Some image.svg|30px]] | ||
| smalltext = A shorter message body text. | | smalltext = A shorter message body text. | ||
| plainlinks = no | |||
}} | }} | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Note: The small parameters only have effect when the template | Note: The small parameters only have effect when the template appears on an article, talk or "other" page type. For their associated documentation, see {{tl|Ambox}}, {{tl|Tmbox}} and/or {{tl|Ombox}}. Using the small parameters when they are not valid has no effect, but also does no harm. | ||
== About demospace == | |||
This template optionally takes the "demospace" parameter as described at {{tl|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. | |||
== | == Mbox family == | ||
{ | {{Mbox templates see also}} | ||
== See also == | == See also == | ||
* [[ | * [[:Category:Mbox and messagebox templates]] | ||
<includeonly> | <includeonly>{{Sandbox other|| | ||
<!-- Add categories below this line, and interwikis at Wikidata --> | |||
[[Category:Mbox and messagebox templates]] | |||
}}</includeonly> | |||
Latest revision as of 10:01, 17 February 2025
 | 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. |
Template:Cascade-protected template
 | Uses Lua: |
| 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 |
{{Mbox}} stands for Multi-namespace messagebox, a metatemplate with which namespace-sensitive messagebox templates can be implemented.
The most common are {{Ambox}} for articles, {{Tmbox}} for talk pages, {{Imbox}} for file (formerly image) pages, {{Cmbox}} for category pages and {{Ombox}} for other types of page.
Usage
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 the varieties just listed. 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.
This template takes the same parameters as {{Ambox}}, {{Imbox}}, etc. 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.
Parameters
List of all parameters:
{{Mbox
| name = name of the template
| 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}}} / left / no
| smallimage = none / [[File:Some image.svg|30px]]
| smallimageright = none / [[File:Some image.svg|30px]]
| smalltext = A shorter message body text.
| plainlinks = no
}}Note: The small parameters only have effect when the template appears on an article, talk or "other" page type. For their associated documentation, see {{Ambox}}, {{Tmbox}} and/or {{Ombox}}. Using the small parameters when they are not valid has no effect, but also does no harm.
About demospace
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.
Mbox family
There are seven metatemplates in the Module:Message box family:
- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Article stub box}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.
See also