Template:Mbox/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{template rating|p}}
{{Lua|Module:Message box}}
__NOTOC__


This is the {{tl|mbox}} or '''multi namespace message box''' meta-template.
{{tl|Mbox}} stands for '''M'''ulti-namespace message'''box''', a [[wikipedia:MTM|metatemplate]] with which [[Wikipedia:Namespace|namespace]]-sensitive messagebox templates can be implemented.  


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 {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}}.
The most common are {{tl|Ambox}} for articles, {{tls|Tmbox}} for talk pages, {{tls|Imbox}} for file (formerly image) pages, {{tl|Cmbox}} for category pages and {{tl|Ombox}} for other types of page.
 
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 {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} or {{tl|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 ==
== Usage ==
This template takes the same parameters as {{tl|ambox}} and {{tl|imbox}} etc. See full documentation there.
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.
 
== 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.
This template takes the same parameters as {{tl|Ambox}}, {{tls|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.
 
Namespace "Book:" was added to the English Wikipedia on 28 December 2009. This template uses the {{tl|ombox}} style on "Book:" pages or when "demospace=book". And it uses the {{tl|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 ==
== Parameters ==
List of all parameters:
List of all parameters:


<pre>
{{tj|Mbox
{{mbox
  | 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 / {{!(n(}}File:Some image.png{{!}}40px]]
| image = none / [[File:Some image.svg|40px]]
  | imageright: {{!(n(}}File:Some image.png{{!}}40px]]
| imageright = [[File:Some image.svg|40px]]
  | style: CSS values
| style = CSS values
  | textstyle : CSS values
| textstyle = CSS values
  | text : The message body text.
| text = The message body text.
  | small: <nowiki>{{{small|}}}</nowiki> / left / yes
| small = {{{small|}}} / left / yes
  | smallimage: none / {{!(n(}}Image:Some image.png{{!}}30px]]
| smallimage = none / [[Image:Some image.svg|30px]]
  | smallimageright: none / {{!(n(}}Image:Some image.png{{!}}30px]]
| smallimageright = none / [[Image:Some image.svg|30px]]
  | smalltext: A shorter message body text.
| smalltext = A shorter message body text.
}}
}}
</pre>
</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 {{tl|ambox}}, {{tl|tmbox}} and {{tl|ombox}}. Using the small parameters when they are not valid has no effect, but also does no harm.
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 {{tl|ambox}}, {{tls|tmbox}} and {{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 {{tls|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&nbsp;= image" which means the same thing as "demospace&nbsp;= file". But using "demospace&nbsp;= image" is now deprecated.


== Message boxes ==
== Message boxes ==
Line 45: Line 41:
! Template !! Description
! Template !! Description
|-
|-
| {{tl|ambox}} || Article message box, identifies problems or issues with the article
| {{tl|Ambox}} || Article message box, identifies problems or issues with the article
|-
|-
| {{tl|cmbox}} || Category message box, {{tl|ambox}} for categories
| {{tl|Cmbox}} || Category message box, {{tl|ambox}} for categories
|-
|-
| {{tl|imbox}} || Image message box, {{tl|ambox}} for file (image) pages
| {{tls|Imbox}} || Image message box, {{tl|ambox}} for file (image) pages
|-
|-
| {{tl|ombox}} || Other pages message box, {{tl|ambox}} for pages of the types User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces
| {{tl|Ombox}} || Other pages message box, {{tl|ambox}} for pages of the types User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces
|-
|-
| {{tl|tmbox}} || Talk page message box, {{tl|ambox}} for talk pages
| {{tls|Tmbox}} || Talk page message box, {{tl|ambox}} for talk pages
|-
|-
! colspan = 2 | The following templates are not called by Mbox
! colspan = 2 | The following templates are not called by Mbox
|-
|-
| {{tl|dmbox}} || Disambiguation footer message box, used for "disambiguation" and "set index" articles
| {{tls|Dmbox}} || Disambiguation footer message box, used for "disambiguation" and "set index" articles
|-
|-
| {{tl|fmbox}} || used in system messages
| {{tls|Fmbox}} || used in system messages
|}
|}


<includeonly>
<includeonly>{{sandbox other||{{testcases other||
 
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Templates]]
</includeonly>
}}}}</includeonly>

Revision as of 06:43, 15 June 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


{{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
| demospace = / main / talk / file / category / other
| type = speedy / delete / content / style / notice / move / protection
| image = none / [[File:Some image.png|40px]]
| imageright = [[File:Some image.png|40px]]
| style = CSS values
| textstyle = CSS values
| text = The message body text.
| small = {{{small|}}} / left / yes
| smallimage = none / [[Image:Some image.png|30px]]
| smallimageright = none / [[Image:Some image.png|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.

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.

Message boxes

Template Description
{{Ambox}} Article message box, identifies problems or issues with the article
{{Cmbox}} Category message box, {{ambox}} for categories
{{Imbox}} Image message box, {{ambox}} for file (image) pages
{{Ombox}} Other pages message box, {{ambox}} for pages of the types User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces
{{Tmbox}} Talk page message box, {{ambox}} for talk pages
The following templates are not called by Mbox
{{Dmbox}} Disambiguation footer message box, used for "disambiguation" and "set index" articles
{{Fmbox}} used in system messages


Retrieved from "http://hibikiforum.net/index.php?title=Template:Mbox/doc&oldid=97401"