Template:Wp/pgh/Mbox/wikitext/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, and Ombox. The styles for this template can be found at MediaWiki:Mbox.css.

Usage


Options

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

Boxes
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.

Imbox
Imbox templates are image message boxes.

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

Tmbox
Tmbox templates are talk page message boxes.

Ombox
Ombox templates are other pages message boxes.

Fmbox
Fmbox templates are footer or header message boxes.

General deletion boxes
While this section is going show general deletion templates, the principles can be applied to any other  neural   of box. Note,  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.





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

Here is the code for the above box.

Small Cmbox
This is a message box that can be used to highlight minor issues with the category. It is suggested to use a normal box for bigger problems with category.

Here is the code for the above box.

Small Imbox
This is a message box that can be used to highlight minor issues with the image or documentation of it. It is suggested to use a normal box for bigger problems with the image.

Here is the code for the above box.

Small Xmbox
This is a message box that can be used to highlight minor issues with a template or documentation of it. It is suggested to use a normal box for bigger problems with the template or documentation.

Here is the code for the above box.

Small Tmbox
This is a message box that can be used to highlight minor issues with a talk page. It is suggested to use a normal box for bigger problems with the talk page.

Here is the code for the above box.

Small Ombox
This is a message box that can be used to highlight minor issues with a section of a page. It is suggested to use a normal box for bigger problems with the entire page.

Here is the code for the above box.

File list
Template:Mbox Template:Ambox Template:Cmbox Template:Imbox Template:Tmbox Template:Xmbox Template:Ombox Template:Fmbox Template:Mbox/doc Template:Ambox/doc Template:Cmbox/doc Template:Imbox/doc Template:Tmbox/doc Template:Xmbox/doc Template:Ombox/doc Template:Fmbox/doc Template:Mbox/style sheet Category:Message box templates