Toggle search
Toggle menu
5
19
4
266
MoonGlasses Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Mbox/doc: Difference between revisions

Template page
More actions
Newer edit →
VisualWikitext
Deps
 
mediawiki>Quiddity II
→Parameters: syntaxhighlight
Line 1: Line 1:
<includeonly>{{Languages|Template:Mbox}}</includeonly>
{{Mbox templates}}
{{Documentation subpage}}
{{Documentation subpage}}
{{dependencies|Module:Message box|Module:Message box/configuration|Module:Yesno}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
<!-- Please add categories to the /doc subpage, and interwikis at Wikidata (see Wikipedia:Wikidata) -->
{{Lua|Module:Message box}}
 
{{Uses TemplateStyles
You may want to use [[Template:Ambox]] or [[Template:MessageBox]] instead, which have fewer features but are easier to export.
| Module:Message box/ambox.css
 
| Module:Message box/cmbox.css
{{tl|mbox}} stands for '''m'''essage '''box''', which is a metatemplate used to build message boxes for other templates. It offers several different colours, images and some other features.
| Module:Message box/imbox.css
 
| Module:Message box/ombox.css
==Basic usage==
| Module:Message box/tmbox.css
The box below shows the most common parameters that are accepted by {{Tl|mbox}}. The purpose of each is described below.
<pre style="overflow:auto;">
{{mbox
| name  =
| small = {{{small|}}}
| type  =
| image =
| sect  = {{{1|}}}
| issue =
| talk  = {{{talk|}}}
| fix  =
| date  = {{{date|}}}
| cat  =
| all  =
}}
</pre>
 
==Full usage==
The "All parameters" box shows all possible parameters for this template. However, it is not recommended to copy this, because it will never be required to use all parameters simultaneously.
 
{| class="wikitable" align="left" style="background:transparent; width=30%;"
!All parameters
|-
|<pre style="font-size:100%">
{{mbox
| name        =
| small      = {{{small|}}}
| type        =
| image      =
| imageright  =
| smallimage  =
| smallimageright =
| class      =
| style      =
| textstyle  =
| sect        = {{{1|}}}
| issue      =
| talk        = {{{talk|}}}
| fix        =
| date        = {{{date|}}}
| text        =
| smalltext  =
| plainlinks  = no
| removalnotice =
| cat        =
| all        =
| cat2        =
| all2        =
| cat3        =
| all3        =
}}
</pre>
|}
{{clear}}
==Common parameters==
=== ''name'' ===
The ''name'' parameter specifies the name of the template, without the Template namespace prefix. For example [[w:Template:Underlinked]] specifies {{Para|name|Underlinked}}.
 
This parameter should be updated if the template is ever moved. The purpose of this parameter is to allow the template to have a more useful display on its template page, for example to show the date even when not specified, and to apply categorisation of the template itself.
 
=== ''small'' ===
The ''small'' parameter should be passed through the template, as this will allow editors to use the small format by specifying {{para|small|left}} on an article:
{{mbox|nocat=true|small=left|text=This is the small left-aligned mbox format.}}
Otherwise the standard format will be produced:
{{mbox|nocat=true|text=This is the standard mbox format.}}
 
Other variations:
* For templates which should ''never'' be small, specify {{Para|small|no}} or do not pass the small parameter at all.
* For templates which should ''always'' be small, just specify {{Para|small|left}}.
* For templates which should ''default to small'', try {{para|small|<nowiki>{{{small|left}}}</nowiki>}}. This will allow an editor to override by using {{para|small|no}} on an article.
 
To use a small box that adjusts its width to match the text, use {{para|style|width: auto; margin-right: 0px;}} and {{para|textstyle|width: auto;}} together:
{{mbox|nocat=true|small=left|style=width: auto; margin-right: 0px;|textstyle=width: auto; margin-right: 0px;|text=This is the small left-aligned Ambox format with flexible width.}}
 
See [[#Sect]] below for more information on how to limit {{para|small}} display to cases when the template is being used for a section instead of the whole article (recommended, to prevent inconsistent top-of-article display).
 
=== ''type'' ===
The ''type'' parameter defines the colour of the left bar, and the image that is used by default. The type is chosen not on aesthetics but is based on the type of issue that the template describes. The seven available types and their default images are shown below.
{{mbox
|nocat=true
| type  = speedy
| text  = type=<u>speedy</u> – Speedy deletion issues
}}
{{mbox
|nocat=true
| type  = delete
| text  = type=<u>delete</u> – Deletion issues,
}}
{{mbox
|nocat=true
| type  = content
| text  = type=<u>content</u> – Content issues
}}
{{mbox
|nocat=true
| type  = style
| text  = type=<u>style</u> – Style issues
}}
{{mbox
|nocat=true
| type  = notice
| text  = type=<u>notice</u> – Article notices
}}
{{mbox
|nocat=true
| type  = move
| text  = type=<u>move</u> – Merge, split and transwiki proposals
}}
{{mbox
|nocat=true
| type  = protection
| text  = type=<u>protection</u> – Protection notices,
}}
}}
{{High-use|15,000}}


If no ''type'' parameter is given the template defaults to {{para|type|notice}}.
This is the {{tlx|mbox}} or '''multi namespace message box''' meta-template.
 
=== ''image'' ===
You can choose a specific image to use for the template by using the ''image'' parameter. Images are specified using the standard syntax for inserting files. Widths of 40-50px are typical.
 
Please note:
* If no image is specified then the default image corresponding to the ''type'' is used. (See [[#type]] above.)
* If {{para|image|none}} is specified, then no image is used and the text uses the whole message box area.
 
=== ''sect'' ===
Many message templates begin with the text '''This article ...''' and it is often desirable that this wording change to '''This section ...''' if the template is used on a section instead. The value of this parameter will replace the word "article". Various possibilities for use include: {{para|sect|list}}, {{para|sect|table}}, {{para|sect|"In popular culture" material}}, etc.
 
If using this feature, be sure to remove the first two words ("This article") from the template's text, otherwise it will be duplicated.
 
A common way to facilitate this functionality is to pass {{para|sect|<nowiki>{{{1|}}}</nowiki>}}. This will allow editors to type <kbd>section</kbd>, for example, as the first unnamed parameter of the template to change the wording. Another approach is to pass {{para|sect|<nowiki>{{{section|{{{sect|}}}}}}</nowiki>}} to provide a named value.
 
=== ''issue'' and ''fix'' ===
The ''issue'' parameter is used to describe the issue with the page. Try to keep it short and to-the-point (approximately 10-20 words).
 
The ''fix'' parameter contains some text which describes what should be done to improve the page. It may be longer than the text in ''issue'', but should not usually be more than two sentences.
 
When the template is in its small form (when using {{para|small|left}}), the ''issue'' is the only text that will be displayed. For example [[w:Template:Citation style]] defines
 
When used stand-alone it produces the whole text:
 
But when used with |small=left it displays only the issue:
 
=== ''talk'' ===
Some message templates include a link to the talk page, and allow an editor to specify a section heading to link directly to the relevant section. To achieve this functionality, simply pass the ''talk'' parameter through, i.e. talk=<nowiki>{{{talk|}}}</nowiki>
 
This parameter may then be used by an editor as follows:
* talk=SECTION HEADING – the link will point to the specified section on the article's talk page, e.g. talk=Foo.
* talk=FULL PAGE NAME – the template will link to the page specified (which may include a section anchor), e.g. talk=Talk:Banana#Foo
 
Notes:
* When this parameter is used by a template, the talk page link will appear on the template itself (in order to demonstrate the functionality) but this will only display on articles if the parameter is actually defined.
* In order to make sure there is always a link to the talk page, you can use |talk=<nowiki>{{{talk|#}}}</nowiki>.
* If the talk page does not exist, there will be no link, whatever the value of the parameter.
 
=== ''date'' ===
Passing the ''date'' parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a bot). This will be displayed after the message in a smaller font.
 
Passing this parameter also enables monthly cleanup categorisation when the ''cat'' parameter is also defined.
 
=== ''info'' ===
This parameter is for specifying additional information. Whatever you add here will appear after the date.
 
=== ''cat'' ===
This parameter defines a monthly cleanup category. If |cat=CATEGORY then:
* articles will be placed in '''Category:CATEGORY from DATE''' if  |date=DATE is specified.
* articles will be placed in '''Category:CATEGORY''' if the date is not specified.
 
For example, [[w:Template:No footnotes]] specifies |cat=Articles lacking in-text citations and so an article with the template {{Tlx|No footnotes|2=date=June 2010|SISTER=w:}} will be placed in [[w:Category:Articles lacking in-text citations from June 2010]].
 
The ''cat'' parameter should not be linked, nor should the prefix <code>Category:</code> be used.
 
=== ''all'' ===
The ''all'' parameter defines a category into which all articles should be placed.
 
The ''all'' parameter should not be linked, nor should the prefix <code>Category:</code> be used.


== Additional parameters ==
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}}.
=== ''imageright'' ===
An image on the right side of the message box may be specified using this parameter. The syntax is the same as for the ''image'' parameter, except that the default is no image.


=== ''smallimage'' and ''smallimageright'' ===
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.
Images for the small format box may be specified using these parameters. They will have no effect unless {{para|small|left}} is specified.


=== ''class'' ===
== Usage ==
Custom [[w:Cascading Style Sheets|CSS]] classes to apply to the box. If adding multiple classes, they should be space-separated.
This template takes the same parameters as {{tlx|ambox}} and {{tlx|imbox}} etc. See full documentation there.


=== ''style'' and ''textstyle'' ===
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.
Optional CSS values may be defined, without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>.
* ''style'' specifies the style used by the entire message box table. This can be used to do things such as modifying the width of the box.
* ''textstyle'' relates to the text cell.


=== ''text'' and ''smalltext'' ===
== Demospace ==
Instead of specifying the ''issue'' and the ''fix'' it is possible to use the ''text'' parameter instead.
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.


Customised text for the small format can be defined using ''smalltext''.
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.


=== ''plainlinks'' ===
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".
Normally on Wikipedia, external links have an arrow icon next to them, like this: [http://www.example.com Example.com]. However, in message boxes, the arrow icon is suppressed by default, like this: <span class="plainlinks">[http://www.example.com Example.com]</span>. To get the normal style of external link with the arrow icon, use {{para|plainlinks|no}}.


=== ''cat2'', ''cat3'', ''all2'', and ''all3'' ===
== Parameters ==
* ''cat2'' and ''cat3'' provide for additional monthly categories; see [[#cat]].
List of all parameters:
* ''all2'' and ''all3'' provide for additional categories into which all articles are placed, just like [[#all]].


== Technical notes ==
<syntaxhighlight lang=wikitext>
* If you need to use special characters in the text parameter then you need to escape them like this:
<syntaxhighlight lang="xml">
{{mbox
{{mbox
|nocat=true
| demospace = {{{demospace|}}} / main / talk / file / category / other
| text  = <div>
| type  = speedy / delete / content / style / notice / move / protection
Equal sign = and a start and end brace { } work fine as they are.
| image = none / [[File:Some image.svg|40px]]
But here is a pipe &#124; and two end braces <nowiki>}}</nowiki>.
| imageright = [[File:Some image.svg|40px]]
And now a pipe and end braces <nowiki>|}}</nowiki>.
| style = CSS values
</div>
| 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.
}}
}}
</syntaxhighlight>
</syntaxhighlight>
{{mbox
|nocat=true
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are.
But here is a pipe &#124; and two end braces <nowiki>}}</nowiki>.
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}


* The <code>&lt;div></code> tags that surround the text in the example above are usually not needed. But if the text contains line breaks then sometimes we get weird line spacing. This especially happens when using vertical dotted lists. Then use the div tags to fix that.
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.
* 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 background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons.


== TemplateData ==
=== TemplateData ===
{{TemplateData header}}
<templatedata>
<templatedata>
{
{
"description": "This is the {{mbox}} or “multi namespace message box” meta-template.",
"format": "block",
"params": {
"params": {
"1": {},
"demospace": {
"small": {
"label": "Demo Namespace",
"label": "Small Mode",
"suggestedvalues": [
"description": "The small parameter should be passed through the template, as this will allow editors to use the small format by specifying |small=left on an article.",
"main",
"talk",
"file",
"category",
"other"
],
"type": "string"
},
"type": {
"label": "Type",
"suggestedvalues": [
"speedy",
"delete",
"content",
"style",
"notice",
"move",
"protection"
],
"type": "string",
"type": "string",
"default": "notice",
"suggested": true
},
"image": {
"label": "Image (left)",
"suggestedvalues": [
"suggestedvalues": [
"no",
"none"
"left"
],
]
"default": "Depends on the “type” parameter.",
"suggested": true,
"type": "content"
},
"imageright": {
"label": "Image (right)",
"type": "content"
},
"style": {
"label": "CSS Style",
"type": "string"
},
},
"talk": {},
"textstyle": {
"date": {},
"label": "Text CSS Style",
"name": {
"label": "Template Name",
"description": "The name parameter specifies the name of the template, without the Template namespace prefix. ",
"type": "string"
"type": "string"
},
},
"type": {},
"text": {
"image": {},
"label": "Text",
"sect": {},
"suggested": true,
"issue": {},
"type": "content"
"fix": {},
},
"info": {},
"small": {
"cat": {},
"label": "Small?",
"all": {},
"suggestedvalues": [
"imageright": {},
"{{{small|}}}",
"class": {},
"left",
"text ": {},
"yes",
"plainlinks": {},
"1"
"smallimage ": {},
],
"smallimageright": {},
"default": "0",
"textstyle": {},
"type": "boolean"
"style ": {},
},
"smalltext": {},
"smallimage": {
"cat2": {},
"label": "Small Image (left)",
"cat3": {},
"suggestedvalues": [
"all2": {},
"none"
"all3": {}
],
},
"default": "{{{image}}}",
"paramOrder": [
"type": "content"
"name",
},
"small",
"smallimageright": {
"type",
"label": "Small Image (right)",
"image",
"suggestedvalues": [
"sect",
"none"
"issue",
],
"fix",
"default": "{{{imageright}}}",
"talk",
"type": "content"
"date",
},
"1",
"smalltext": {
"info",
"label": "Small Text",
"cat",
"default": "{{{text}}}",
"all",
"type": "content"
"imageright",
}
"class",
}
"text ",
"plainlinks",
"smallimage ",
"smallimageright",
"textstyle",
"style ",
"smalltext",
"cat2",
"cat3",
"all2",
"all3"
]
}
}
</templatedata>
</templatedata>


<includeonly>[[Category:Notice templates]]</includeonly>
== 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>

Revision as of 00:32, 6 June 2024

<translate> Message box templates</translate>

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

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

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 {{ombox}} style on "Book:" pages or when "demospace=book". And it uses the {{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: 

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

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.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Mbox

This is the {{mbox}} or “multi namespace message box” meta-template.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Demo Namespacedemospace

no description

Suggested values
main talk file category other
Stringoptional
Typetype

no description

Suggested values
speedy delete content style notice move protection
Default
notice
Stringsuggested
Image (left)image

no description

Suggested values
none
Default
Depends on the “type” parameter.
Contentsuggested
Image (right)imageright

no description

Contentoptional
CSS Stylestyle

no description

Stringoptional
Text CSS Styletextstyle

no description

Stringoptional
Texttext

no description

Contentsuggested
Small?small

no description

Suggested values
{{{small|}}} left yes 1
Default
0
Booleanoptional
Small Image (left)smallimage

no description

Suggested values
none
Default
{{{image}}}
Contentoptional
Small Image (right)smallimageright

no description

Suggested values
none
Default
{{{imageright}}}
Contentoptional
Small Textsmalltext

no description

Default
{{{text}}}
Contentoptional

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
{{fmbox}} used in system messages

See also


Retrieved from "https://www.moonglasses.wiki/index.php?title=Template:Mbox/doc&oldid=1275"
MediaWiki Appliance - Powered by TurnKey Linux