Vorlage:Fmbox/Doku

This is the {{fmbox}} or header & footer message box template.

It can be used to build message boxes for system messages such as MediaWiki:Sharedupload and MediaWiki:Sp-contributions-footer-anon. It can also be used for header and footer boxes on user pages.

This template works similarly to {{ambox}} and mostly uses the same parameters. The main difference is that this box is 100% wide and only has one colour style.

Usage

Simple usage example:

{{fmbox | text = Some text.}}

Complex example:

{{fmbox
| image     = [[Image:Emblem-question-yellow.svg|40px]]
| style     = background: transparent;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

Other images

The default image shown above is mostly for testing and demonstration. In most cases it is more appropriate to use a more specific image or no image at all. These examples use the image parameter to specify an image other than the default image.

Special

Some other parameter combinations.

Parameters

List of all parameters:

{{imbox
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| textstyle = CSS value
| text  = The message body text.
}}

image

No parameter = If no image parameter is given the template uses its default image.

An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:

image = [[Image:User-info.svg|40px]]

none = Means that no image is used.

imageright

No parameter = If no imageright parameter is given then no image is shown on the right side.

An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:

imageright = [[Image:Nuvola apps bookcase.png|40px]]

Anything = Any other object that you want to show on the right side.

style

An optional CSS value used by the entire message box table. Without quotation marks " ". For example:

style = margin-top: 1em;

textstyle

An optional CSS value used by the text cell. For example:

textstyle = font-size: 90%; text-align: center;

text

The message body text.

Technical details

This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned.

If you need to use special characters in the text parameter then you need to escape them like this:

{{fmbox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. 
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}

Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.

Note to admins: MediaWiki does not parse and convert HTML in system messages the same way as it does for normal pages. This means for instance that <br> is not automatically converted to <br /> and missing </td> and </tr> tags are not automatically added. Thus see to that any HTML code you use in system messages are valid XHTML. That is, close all tags that you begin. However, regular wikimarkup works fine in most system messages.

For more technical details see the talk page. Since this template works almost exactly like {{ambox}}, {{tmbox}}, {{imbox}}, {{cmbox}} and {{ombox}} their talk pages and related pages might also contain more details.

See also

There are several meta-templates in the mbox family:

• {{ambox}} – For article message boxes.
• {{tmbox}} – For talk page message boxes.
• {{imbox}} – For image page message boxes.
• {{cmbox}} – For category message boxes.
• {{ombox}} – For other pages message boxes.
• {{mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.
• {{fmbox}} – For header and footer message boxes.