Teamplaid:Fmbox/documentation

For the message box for File: pages, see Template:Fmbox.

Bogsa-teachdaireachd / Message box meata-teamplaidean / meta-templates
Teamplaid	Co-theacsa / Context
{{Ambox}}	alt / article
{{Cmbox}}	roinn-seòrsa / category
{{Imbox}}	dealbh / image
{{Tmbox}}	deasbaireachd / talk
{{Fmbox}}	bun-nòta / footer ceann-sgrìobhainne / header
{{Ombox}}	duilleagan eile / other pages
{{Mbox}}	fèin-lorg / auto-detect
{{Asbox}}	alt bunag / article stub
{{Dmbox}}	aon-seaghach / disambiguation
{{Ivmbox}}	trom-chùiseach / important messages

This is the {{Fmbox}} ([F]ooter and header [m]essage [box]) template.

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

This template works similarly to {{Ambox}} and mostly uses the same parameters. The main differences are that this box is 100% wide and has different colour styles.

Ùsaid - Usage

Simple example

{{Fmbox |text=Some text.}}

produces:

Complex example

{{Fmbox
 | type = editnotice
 | image = [[Faidhle:Emblem-question-yellow.svg|40px]]
 | style = border:1px solid #f4c430;
 | textstyle = font-style:italic; font-weight:bold; color:red;
 | text = The message's text.
}}

produces:

Footer and header message box types

The following examples use different type parameters but no image parameters, i.e. they use the default image for each type.

Non-default images

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

Paramadairean - Parameters

List of all parameters:

{{Fmbox
| name = name of the template
| type  = system / editnotice / warning
| image = none / [[Faidhle:Some image.svg|40px]]
| imageright = [[Faidhle:Some image.svg|40px]]
| id = CSS id
| class = CSS class names
| style = CSS values
| textstyle = CSS values
| plainlinks  = no
| text  = The message body text.
}}

name

(Optional) Name of the template. This adds a CSS class with name box-name to the HTML element, for use by bots or scripts.

type

If no type parameter is given the template defaults to type system. That means it gets a light grey background.

image

No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.

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 = [[Faidhle: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 = [[Faidhle:Nuvola apps bookcase.png|40px]]

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

id

Optional CSS id used by the entire message box table. Without quotation marks " ". Mostly meant to be used to Tag a message box with its name, to make it easy to detect the presence of the message from javascript. For instance MediaWiki:Sp-contributions-footer would use:

id = sp-contributions-footer

class

Optional CSS class names used by the entire message box table. Without quotation marks " ". Mostly meant to be used to Tag a message box with its name so it can be individually skinned. For instance MediaWiki:Sp-contributions-footer would use:

class = sp-contributions-footer

style

Optional CSS values used by the entire message box table. Without quotation marks " " but with the ending semicolons ;. For example:

style = margin-top: 1em;

textstyle

Optional CSS values used by the text cell. For example:

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

plainlinks

Normally on Wikipedia, external links have an arrow icon next to them, like this: Example.com. However, in message boxes, the arrow icon is suppressed by default, like this: Example.com. To get the normal style of external link with the arrow icon, use |plainlinks=no.

text

The message body text.

Mion-fhiosrachadh teicnigeach - Technical details

This template currently uses hard coded styles and class names. Later it will only use CSS classes making it easier to skin. (In the meantime it can be skinned by using the "!important" keyword.)

If you need to make a box that is less than 100% wide, then do not use this box; instead, use {{Ombox}}. Since this box doesn't have the "1px empty image cell" code that makes it so the other mboxes get proper box flow in all browsers when less than 100% wide.

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

This produces:

To avoid potential difficulties with e.g. parser functions or special characters, this metatemplate uses HTML rather than wiki markup to produce the table carrying its output.

As some older browsers have difficulty rendering SVG transparency, the default images for this metatemplate are in PNG rather than SVG format and have been optimised by hand to ensure they work across a wide range and age of browsers. (SVG icons only look somewhat bad in older browsers, thus such optimisation is only worthwhile for very widely used icons.)

Admins: MediaWiki's parsing and converting HTML markup for system messages is not the same as for normal pages: <br> for instance, is not automatically converted to <br /> and missing </td> and </tr> tags are not added automatically. Any HTML code used in system messages, therefore, must already be valid (include all complementary close tags, etc.).

For more details, see the talk page. Since this template works in almost the same way as {{Ambox}}, {{Tmbox}}, {{Imbox}}, {{Cmbox}} and {{Ombox}}, further information found on their talk pages may also be relevant.

Faic cuideachd - Also see

• {{Fmbox warning ruler}}, a horizontal ruler, used within some system warning notices, that uses the same red as this template's warning type.

There are seven meta-templates in the Module:Message box family:

• {{Ambox}} – For article message boxes.
• {{Cmbox}} – For category message boxes.
• {{Imbox}} – For file (image) page message boxes.
• {{Fmbox}} – For header and footer 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.
• {{Ombox}} – For other pages message boxes.
• {{Tmbox}} – For talk page message boxes.

Closely related meta-templates:

• {{Asbox}} – For article stub message boxes.
• {{Dmbox}} – For disambiguation and set index message boxes.
• {{Ivmbox}} – A simplistic, full-width box intended to surround important messages or notices, with an ivory background by default.