FloofyPlasma: Created page with "{{documentation header}} {{shortcut|msgbox|notice|mbox|ambox}} This template is used to add consistent styling to message boxes. == Usage ==

{{Message box | mini = Mini mode | small = Mini mode | subtle = Subtle mode | class = Classes for the template | type = Notice type | bgcol = Custom background color | linecol = Custom line color | width = Custom width | float = Custom alignment | icon = Icon from Template:CommentSprite | imagecss = Cus..."

2024-08-06T20:22:13Z

Created page with "{{documentation header}} {{shortcut|msgbox|notice|mbox|ambox}} This template is used to add consistent styling to message boxes. == Usage == <pre style="display: table;">{{Message box | mini = Mini mode | small = Mini mode | subtle = Subtle mode | class = Classes for the template | type = Notice type | bgcol = Custom background color | linecol = Custom line color | width = Custom width | float = Custom alignment | icon = Icon from Template:CommentSprite | imagecss = Cus..."

New page

{{documentation header}}
{{shortcut|msgbox|notice|mbox|ambox}}
This template is used to add consistent styling to message boxes.

== Usage ==
<pre style="display: table;">{{Message box
| mini = Mini mode
| small = Mini mode
| subtle = Subtle mode
| class = Classes for the template
| type = Notice type
| bgcol = Custom background color
| linecol = Custom line color
| width = Custom width
| float = Custom alignment
| icon = Icon from Template:CommentSprite
| imagecss = Custom image CSS
| image = Extra image
| imagetextbefore = Text before the image
| imagetextafter = Text after the image
| imagesize = Image size
| title = Template title
| discuss = Discuss button
| discussPage = Talk page link
| discussAnchor = Talk page section specification
| linkshere = Links button to Special:WhatLinksHere
| text = Template text
| css = Custom CSS
}}</pre>

=== Parameters ===
<templatedata>
{
"params": {
"mini": {
"label": "Mini mode",
"description": "Changes the message box size to one that is more suited to an article section.",
"type": "boolean",
"aliases": [
"small"
]
},
"subtle": {
"label": "Subtle mode",
"description": "Changes the message box to be smaller and float to the side in line with an infobox.",
"type": "boolean"
},
"type": {
"label": "Type",
"description": "Message box notice category. See [[#Types]].",
"example": "<code>type=content</code> for a content issue msgbox",
"type": "string"
},
"class": {
"label": "Class",
"description": "Adds class to the template.",
"type": "string",
"suggested": true
},
"bgcol": {
"label": "Background color",
"description": "Changes the background color.",
"type": "string",
"default": "#FCFCFC"
},
"linecol": {
"label": "Line color",
"description": "Changes the line color.",
"type": "string"
},
"width": {
"label": "Width",
"description": "Changes the template width.",
"type": "string",
"default": "90%; 30em in mini mode"
},
"float": {
"label": "Alignment",
"description": "Changes the template position.",
"type": "string"
},
"icon": {
"label": "Icon",
"description": "Adds an icon from Template:CommentSprite. Incompatible with the {{{image}}} parameter and its derivatives.",
"type": "string"
},
"imagecss": {
"label": "Image CSS customization",
"description": "Further customization of an image on the message box with CSS.",
"type": "string"
},
"image": {
"label": "Image",
"description": "Adds an image icon to the template. Incompatible with the {{{icon}}} parameter.",
"type": "wiki-file-name"
},
"imagetextbefore": {
"label": "Additional text",
"description": "Adds a text before/above the image.",
"type": "string"
},
"imagetextafter": {
"label": "Additional text",
"description": "Adds a text after/below the image.",
"type": "string"
},
"imagesize": {
"label": "Image size",
"description": "Changes the image size if the {{{image}}} parameter is set.",
"type": "string",
"default": "32px; 16px in mini mode"
},
"title": {
"label": "Title",
"description": "Adds a title to the template.",
"type": "string",
"suggested": true
},
"discuss": {
"label": "Discuss button?",
"description": "Adds a button named [Discuss] that links to the talk page of the page where the message box is used.",
"type": "boolean"
},
"discussPage": {
"label": "Talk page link customization",
"description": "Changes the [Discuss] button to link to a custom talk page.",
"type": "wiki-page-name"
},
"discussAnchor": {
"label": "Talk page section specification",
"description": "Makes the [Discuss] button to link to a specific section of the talk page.",
"type": "string"
},
"linkshere": {
"label": "Links button?",
"description": "Adds a button named [Links] that links to Special:WhatLinksHere which lists the page usage of the current page.",
"type": "boolean"
},
"text": {
"label": "Text",
"description": "Adds text to the template.",
"type": "content",
"suggested": true
},
"css": {
"label": "CSS customization",
"description": "Further customization of the message box with CSS.",
"type": "string"
}
},
"description": "Message boxes are used to create most templates present on the wiki.",
"format": "block"
}
</templatedata>

=== Types ===
Colors are used to indicate the type of message box:
{| class="wikitable"
! '''Criteria'''
! '''Type'''
! '''Color displayed'''
|-
| Unclassified templates (default)
|
| {{msgbox|mini=1|text=Lorem ipsum}}
|-
| Warning for disclaimer/deletion of a page
| <code>type = delete</code>
| {{msgbox|mini=1|type=delete|text=Lorem ipsum}}
|-
| Suggesting a page to be moved/split/merged
| <code>type = move</code>
| {{msgbox|mini=1|type=move|text=Lorem ipsum}}
|-
| Notice for content issues of a page
| <code>type = content</code>
| {{msgbox|mini=1|type=content|text=Lorem ipsum}}
|-
| Notice for style issues of a page
| <code>type = style</code>
| {{msgbox|mini=1|type=style|text=Lorem ipsum}}
|-
| Information regarding the status of a page
| <code>type = notice</code>
| {{msgbox|mini=1|type=notice|text=Lorem ipsum}}
|-
| Details about editions and/or versions
| <code>type = edition</code>
| {{msgbox|mini=1|type=edition|text=Lorem ipsum}}
|-
| Unused/custom purposes
| <code>type = other</code>
| {{msgbox|mini=1|type=other|text=Lorem ipsum}}
|}

== Examples ==
{| class="wikitable"
! '''Code'''
! '''Result'''
|-
| '''Basic usage:'''
<pre style="display:table">
{{msgbox
| title = This is a normal message box
| text = With helpful and descriptive subtext
}}
</pre>
|{{msgbox| title = This is a normal message box | text = With helpful and descriptive subtext}}
|-
| '''Mini usage:'''
<pre style="display:table;">
{{msgbox
| mini = 1
| icon = 8
| text = This has an information icon using [[Template:CommentSprite]]
}}
</pre>
|{{msgbox| mini = 1 | icon = 8 | text = This has an information icon using [[Template:CommentSprite]]}}
|-
| '''Advanced usage:'''
<pre style="display: table;">
{{msgbox
| bgcol = rgba(203, 203, 249, 0.2)
| linecol = rgba(107, 107, 253, 0.2)
| title = This is a blue message box
| text = It has a discuss link, some custom CSS and a custom image
| discuss = 1
| image = Bot.png
| css = box-shadow: 10px 10px 2px #787878;
}}
</pre>
|{{msgbox| bgcol = rgba(203, 203, 249, 0.2) | linecol = rgba(107, 107, 253, 0.2) | title = This is a blue message box | text = It has a discuss link, some custom CSS and a custom image | discuss = 1 | css = box-shadow: 10px 10px 2px #787878 | image = Bot.png}}
|-
| '''Advanced mini usage:'''
<pre style="display: table;">
{{msgbox
| mini = 1
| image = Bot.png
| bgcol = rgba(147, 122, 85, 0.2)
| linecol = rgba(187, 116, 13, 0.2)
| css = box-shadow: 0px 0px 6px #787878;
| text = This is using similar settings as the advanced example above.
}}</pre>
|{{msgbox| mini = 1 | bgcol = rgba(147, 122, 85, 0.2) | linecol = rgba(187, 116, 13, 0.2) | text = This is using similar settings as the advanced example above. | css = box-shadow: 0px 0px 6px #787878;| image = Bot.png|nocat=1}}
|}

{{experiment|2=editcopy}}
<includeonly>

[[Category:Notice templates| ]]
</includeonly>

Template:Msgbox/doc - Revision history