Template:Mbox/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 33: | Line 33: | ||
== About demospace == | == About demospace == | ||
This template optionally takes the "demospace" parameter as described at {{ | 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. | 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. | ||
Line 57: | Line 57: | ||
| {{tls|Fmbox}} || used in system messages | | {{tls|Fmbox}} || used in system messages | ||
|} | |} | ||
== TemplateData == | |||
<templatedata> | |||
{ | |||
"params": { | |||
"name": { | |||
"label": "Template Name", | |||
"description": "The name parameter specifies the name of the template, without the Template namespace prefix. ", | |||
"type": "string" | |||
}, | |||
"demospace": { | |||
"label": "Demospace", | |||
"description": "Used for testing and demonstration purposes.", | |||
"type": "string", | |||
"suggestedvalues": [ "{{{demospace|}}}", "main", "talk", "file", "category", "other" ], | |||
"required": false | |||
}, | |||
"small": { | |||
"label": "Small Mode", | |||
"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.", | |||
"type": "string", | |||
"suggestedvalues": [ "no", "left" ] | |||
}, | |||
"type": { | |||
"label": "Type", | |||
"description": "The type of box.", | |||
"type": "string", | |||
"suggestedvalues": [ "speedy", "delete", "content", "style", "notice", "move", "protection" ], | |||
"required": true | |||
}, | |||
"image": { | |||
"label": "Image", | |||
"description": "You can choose a specific image instead of the default.", | |||
"type": "string", | |||
"example": "[[File:Some image.png|40px]]", | |||
"required": false | |||
}, | |||
"imageright": { | |||
"label": "Image Right", | |||
"description": "An image on the right side of the message box.", | |||
"type": "string", | |||
"example": "[[File:Some image.png|40px]]", | |||
"required": false | |||
}, | |||
"smallimage": { | |||
"label": "Small Image", | |||
"description": "Images for the small format box.", | |||
"type": "string", | |||
"example": "[[File:Some image.png|40px]]", | |||
"required": false | |||
}, | |||
"smallimageright": { | |||
"label": "Small Image Right", | |||
"description": "Images for the small format box.", | |||
"type": "string", | |||
"example": "[[File:Some image.png|40px]]", | |||
"required": false | |||
}, | |||
"style": { | |||
"label": "Style", | |||
"description": "Optional CSS values may be defined, without quotation marks but with the ending semicolons.", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"textstyle": { | |||
"label": "Text Style", | |||
"description": "Optional CSS values may be defined, without quotation marks but with the ending semicolons.", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"text": { | |||
"label": "Text", | |||
"description": "May be used instead of Issue and Fix.", | |||
"type": "string", | |||
"suggested": true, | |||
"required": false | |||
}, | |||
"smalltext": { | |||
"label": "Small Text", | |||
"description": "Defines Customised text for the small format.", | |||
"type": "string", | |||
"required": false | |||
} | |||
} | |||
} | |||
</templatedata> | |||
<includeonly>{{sandbox other||{{testcases other|| | <includeonly>{{sandbox other||{{testcases other|| |
Revision as of 04:04, 18 June 2023
It contains usage information, categories and other content that is not part of the original template page.
|
This template uses Lua: |
{{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:
| 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 |
TemplateData
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template Name | name | The name parameter specifies the name of the template, without the Template namespace prefix. | String | optional |
Demospace | demospace | Used for testing and demonstration purposes.
| String | optional |
Small Mode | small | 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.
| String | optional |
Type | type | The type of box.
| String | required |
Image | image | You can choose a specific image instead of the default.
| String | optional |
Image Right | imageright | An image on the right side of the message box.
| String | optional |
Small Image | smallimage | Images for the small format box.
| String | optional |
Small Image Right | smallimageright | Images for the small format box.
| String | optional |
Style | style | Optional CSS values may be defined, without quotation marks but with the ending semicolons. | String | optional |
Text Style | textstyle | Optional CSS values may be defined, without quotation marks but with the ending semicolons. | String | optional |
Text | text | May be used instead of Issue and Fix. | String | suggested |
Small Text | smalltext | Defines Customised text for the small format. | String | optional |