Template:Mbox/doc

This template is designed to be used in other message templates. It is derived from Mbox on Wikipedia.

{{Mbox}} is the basis for {{Ambox}}, {{Cmbox}}, {{Imbox}}, {{Xmbox}}, {{Tmbox}}, {{Fmbox}}, {{Ombox}} and {{Verbox}}. The styles for this template can be found at MediaWiki:Mbox.css.

Usage[]

{{Mbox
| namespace =
| type  =
| small =
| id    =
| class =
| style =
| textstyle  =
| plainlinks =
| text  =
| issue =
| fix   =
| date  =
| info  =
| image =
| imageright =
| doc =
| cat =
}}

Options[]

namespace - the namespace the box will be used in. If mbox is used where namespace is not specified, the namespace will be determined by where the template is transcluded to.
type
- speedy - speedy delete message box
- delete - delete message box
- content - content message box
- style - style message box
- notice - general message box
- protection - protection message box
small - a small right floated message box, except Ambox that floats left.
id - the id of the box
class - any additional classes for the box
style - any additional styles for the box
plainlinks - if you want all external links to be plain links
textstyle - any additional styles for the text
text - text of the message box or use the following together
- issue - the issue of the message box
- fix - how to fix the message issue
date - the date the message box was placed
info - additional information for the message box
image - image in the left side of the message box
imageright - image in the right side of the message box
doc - answer yes to this when you are using your Mbox template on a documentation page.
cat - this is the category your Mbox will put the pages in where it is used.

Installation[]

To install these templates to your wiki, copy the file list at the end of this documentation to the export page and save it as an xml file. Then go to your wiki's import page and enter the name of the generated xml file.

Style installation[]

These instructions are for the administrators of your wiki. If you are not an admin, please talk to them to complete the installation of this template and its children to your wiki.

Copy the styles from the style page to MediaWiki:Mbox.css. After you have the styles copied and saved, go to either Wikia.css or Common.css and add the following line to the top of the style sheet.

@import url("/load.php?mode=articles&only=styles&articles=MediaWiki:Mbox.css");

Boxen[]

Not all options shown.

This wiki has instant commons. If you want these images, your wiki's admin will have to request instant commons or you will have to upload the images manually.

Ambox[]

{{Ambox}} templates are article message boxes.

Cmbox[]

{{Cmbox}} templates are category message boxes.

This is a category speedy deletion message box.

{{Mbox
| namespace = category
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a category speedy deletion message box.
}}

This is a category deletion message box.

{{Mbox
| namespace = category
| type = delete
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a category deletion message box.
}}

This is a category content message box.

{{Mbox
| namespace = category
| type = content
| image = [[File:Ambox_warning_orange.svg|50px]]
| text = This is a category content message box.
}}

This is a category style noticebox.

{{Mbox
| namespace = category
| type = style
| image = [[File:Ambox_warning_yellow.svg|50px]]
| text = This is a category style noticebox.
}}

This is a category general message box.

{{Mbox
| namespace = category
| type = notice
| image = [[File:Ambox_warning_blue.svg|50px]]
| text = This is a category general message box.
}}

This is a category move message box.

{{Mbox
| namespace = category
| type = move
| image = [[File:Merge-split-transwiki_default.svg|50px]]
| text = This is a category move message box.
}}

This is a category protection message box.

{{Mbox
| namespace = category
| type = protection
| image = [[File:Padlock.svg|50px]]
| text = This is a category protection message box.
}}

Imbox[]

{{Imbox}} templates are image message boxes.

This is an image speedy deletion message box.

{{Mbox
| namespace = file
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is an image speedy deletion message box.
}}

This is an image deletion message box.

{{Mbox
| namespace = file
| type = delete
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is an image deletion message box.
}}

This is an image content message box.

{{Mbox
| namespace = file
| type = content
| image = [[File:Ambox_warning_orange.svg|50px]]
| text = This is an image content message box.
}}

This is an image style message box.

{{Mbox
| namespace = file
| type = style
| image = [[File:Ambox_warning_yellow.svg|50px]]
| text = This is an image style message box.
}}

This is an image general message box.

{{Mbox
| namespace = file
| type = notice
| image = [[File:Ambox_warning_blue.svg|50px]]
| text = This is an image general message box.
}}

This is an image move message box.

{{Mbox
| namespace = file
| type = move
| image = [[File:Merge-split-transwiki_default.svg|50px]]
| text = This is an image move message box.
}}

This is an image protection message box.

{{Mbox
| namespace = file
| type = protection
| image = [[File:Padlock.svg|50px]]
| text = This is an image protection message box.
}}

Xmbox[]

{{Xmbox}} are template message boxes. (Tmbox was taken for all talk pages.)

This is a template speedy deletion message box.

{{Mbox
| namespace = template
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a template speedy deletion message box.
}}

This is a template deletion message box.

{{Mbox
| namespace = template
| type = delete
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a template deletion message box.
}}

This is a template content message box.

{{Mbox
| namespace = template
| type = content
| image = [[File:Ambox_warning_orange.svg|50px]]
| text = This is a template content message box.
}}

This is a template style message box.

{{Mbox
| namespace = template
| type = style
| image = [[File:Ambox_warning_yellow.svg|50px]]
| text = This is a template style message box.
}}

This is a template general message box.

{{Mbox
| namespace = template
| type = notice
| image = [[File:Ambox_warning_blue.svg|50px]]
| text = This is a template general message box.
}}

This is a template move message box.

{{Mbox
| namespace = template
| type = move
| image = [[File:Merge-split-transwiki_default.svg|50px]]
| text = This is a template move message box.
}}

This is a template protection message box.

{{Mbox
| namespace = template
| type = protection
| image = [[File:Padlock.svg|50px]]
| text = This is a template protection message box.
}}

Tmbox[]

{{Tmbox}} templates are talk page message boxes.

This is a talk page speedy deletion message box.

{{Mbox
| namespace = talk
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a talk page speedy deletion message box.
}}

This is a talk page deletion message box.

{{Mbox
| namespace = talk
| type = delete
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a talk page deletion message box.
}}

This is a talk page content message box.

{{Mbox
| namespace = talk
| type = content
| image = [[File:Ambox_warning_orange.svg|50px]]
| text = This is a talk page content message box.
}}

This is a talk page style message box.

{{Mbox
| namespace = talk
| type = style
| image = [[File:Ambox_warning_yellow.svg|50px]]
| text = This is a talk page style message box.
}}

This is a talk page general message box.

{{Mbox
| namespace = talk
| type = notice
| image = [[File:Ambox_warning_blue.svg|50px]]
| text = This is a talk page general message box.
}}

This is a talk page move message box.

{{Mbox
| namespace = talk
| type = move
| image = [[File:Merge-split-transwiki_default.svg|50px]]
| text = This is a talk page move message box.
}}

This is a talk page protection message box.

{{Mbox
| namespace = talk
| type = protection
| image = [[File:Padlock.svg|50px]]
| text = This is a talk page protection message box.
}}

Ombox[]

{{Ombox}} templates are other pages message boxes.

This is an other namespace page speedy deletion message box.

{{Mbox
| namespace = other
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is an other namespace page speedy deletion message box.
}}

This is an other namespace page deletion message box.

{{Mbox
| namespace = other
| type = delete
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is an other namespace page deletion message box.
}}

This is an other namespace page content message box.

{{Mbox
| namespace = other
| type = content
| image = [[File:Ambox_warning_orange.svg|50px]]
| text = This is an other namespace page content message box.
}}

This is an other namespace page style message box.

{{Mbox
| namespace = other
| type = style
| image = [[File:Ambox_warning_yellow.svg|50px]]
| text = This is an other namespace page style message box.
}}

This is an other namespace page general message box.

{{Mbox
| namespace = other
| type = notice
| image = [[File:Ambox_warning_blue.svg|50px]]
| text = This is an other namespace page general message box.
}}

This is an other namespace page move message box.

{{Mbox
| namespace = other
| type = move
| image = [[File:Merge-split-transwiki_default.svg|50px]]
| text = This is an other namespace page move message box.
}}

This is an other namespace page protection message box.

{{Mbox
| namespace = other
| type = protection
| image = [[File:Padlock.svg|50px]]
| text = This is an other namespace page protection message box.
}}

Fmbox[]

{{Fmbox}} templates are footer or header message boxes.

This is a footer or header warning message box.

{{Mbox
| namespace = footer
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = This is a footer or header speedy deletion message box.
}}

This is a footer or header content message box.

{{Mbox
| namespace = footer
| type = content
| image = [[File:Ambox_warning_orange.svg|50px]]
| text = This is a footer or header content message box.
}}

This is a footer or header style message box.

{{Mbox
| namespace = footer
| type = style
| image = [[File:Ambox_warning_yellow.svg|50px]]
| text = This is a footer or header style message box.
}}

This is a footer or header general message box.

{{Mbox
| namespace = footer
| type = notice
| image = [[File:Ambox_warning_blue.svg|50px]]
| text = This is a footer or header general message box.
}}

This is a footer or header move message box.

{{Mbox
| namespace = footer
| type = move
| image = [[File:Merge-split-transwiki_default.svg|50px]]
| text = This is a footer or header move message box.
}}

This is a footer or header protection message box.

{{Mbox
| namespace = footer
| type = protection
| image = [[File:Padlock.svg|50px]]
| text = This is a footer or header protection message box.
}}

General deletion boxen[]

While this section is going show general deletion templates, the principles can be applied to any other namespace neural type of box. Note, namespace is not specified, so the template will take on the style of its name space, meaning it will look like an Xmbox, but they will change their styles when the deletion template is transcluded to a page.

{{Mbox
| type = speedy
| image = [[File:Ambox warning pn.svg|50px]]
| text = '''This page is a candidate for ''speedy'' deletion.'''
| info = ''Remember to check [[Special:Whatlinkshere/{{FULLPAGENAME}}|what links here]] and [{{fullurl:{{FULLPAGENAME}}|action=history}} the page history] before deletion.''
| doc = yes
| cat = Candidates for speedy deletion
}}

This page is a candidate for speedy deletion.

Remember to check what links here and the page history before deletion.

{{Mbox
| type = delete
| image = [[File:Ambox warning pn.svg|50px]]
| text = '''This page is a candidate for deletion.'''
| info = ''Remember to check [[Special:Whatlinkshere/{{FULLPAGENAME}}|what links here]] and [{{fullurl:{{FULLPAGENAME}}|action=history}} the page history] before deletion.''
| doc = yes
| cat = Candidates for deletion
}}

This page is a candidate for deletion.

Remember to check what links here and the page history before deletion.

Small boxen[]

These are small boxen that can be used to include unobtrusive messages to pages. Their borders are all narrow so text can flow around these boxen with little affect on the text. If you do not want text beside the box, you should use the <div style="clear:both"></div> directly after the box.

Small Ambox[]

This is a message box that can be used in a section of an article to highlight issues with the section. It is suggested to use a normal box for problems within the whole article.