View source for Template:Fmbox/doc

{{Documentation subpage}}
{{for|the message box for File: pages|Template:imbox}}
{{Used in system |in many system messages}}
{{high-risk|12900+}}
{{Lua|Module:Message box}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{Mbox templates (small)}}

This is the {{tl|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 [[Wikipedia:Editnotice|editnotices]].

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

===Usage===

'''Simple example'''
<pre>
{{Fmbox |text=Some text.}}
</pre> produces:
{{Fmbox |text=Some text.}}

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

===Footer and header message box types===

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

{{Fmbox |type=warning |text={{mono|type {{=}} warning}}<br/>For system warning notices such as [[MediaWiki:Revision-info]] and [[MediaWiki:Protectedpagewarning]].}}
{{Fmbox |type=editnotice |text={{mono|type {{=}} editnotice}}<br/>Provides a transparent background for [[Wikipedia:Editnotice|editnotices]].}}
{{Fmbox |type=system |text={{mono|type {{=}} system}}<br/>Default light-grey system-message background.}}

===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 {{mono|image}} parameter to specify an image other than the default.

{{Fmbox |image=[[File:User-info.svg|40px]] |text={{mono|image<nowiki> = [[File:User-info.svg|40px]]</nowiki>}}<br/>[[MediaWiki:Sp-contributions-footer]] image.}}
{{Fmbox |image=[[File:Commons-logo.svg|40x40px]] |text={{mono|image<nowiki> = [[File:Commons-logo.svg|40x40px]]</nowiki>}}<br/>[[MediaWiki:Sharedupload-desc-here]] image. The "40x40px" parameter within the File: link sets the height as well as the width of the image.}}

===Other examples===

{{Fmbox |text=Fmbox's default image (i.e. {{mono|image}} left unspecified).}}
{{Fmbox |image=none |text=Setting {{mono|image {{=}} none}} means that the {{mono|text}} uses the whole of the message box.}}
{{Fmbox |image=[[File:User-info.svg|40px]] |imageright=[[File:Nuvola apps bookcase.svg|40px]] |text={{mono|image<nowiki> = [[File:User-info.svg|40px]]</nowiki>}}<br/>{{mono|imageright<nowiki> = [[File:Nuvola apps bookcase.svg|40px]]</nowiki>}} }}

===Parameters===
List of all parameters:

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

'''name'''
:(Optional) Name of the template. This adds a CSS class with name <code>box-''name''</code> 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: 
::<code><nowiki>image = [[Image:User-info.svg|40px]]</nowiki></code>
:'''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: 
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''id'''
:Optional [[Cascading Style Sheets|CSS]] id used by the entire message box table. Without quotation marks <code>" "</code>. 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:
::<code>id = sp-contributions-footer</code>

'''class'''
:Optional [[Cascading Style Sheets|CSS]] class names used by the entire message box table. Without quotation marks <code>" "</code>. 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:
::<code>class = sp-contributions-footer</code>

'''style'''
:Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-top: 1em;</code>

'''textstyle'''
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = font-size: 90%; text-align: center;</code>

'''plainlinks'''
:Normally on Wikipedia, external links have an arrow icon next to them, like this: [http://www.example.com Example.com]. However, in message boxes, the arrow icon is suppressed by default, like this: <span class="plainlinks">[http://www.example.com Example.com]</span>. To get the normal style of external link with the arrow icon, use {{para|plainlinks|no}}.

'''text'''
:The message body text.

===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 "<code>!important</code>" keyword.)

If you need to make a box that is less than 100% wide, then do ''not'' use this box; instead, use {{tl|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 {{mono|text}} parameter, then you need to "escape" them like this: 
<pre>
{{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 &lt;nowiki>}}&lt;/nowiki&gt;. 
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki&gt;.
</div>
}}
</pre>
This produces:
{{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>
}}

To avoid potential difficulties with e.g. [[Help:ParserFunctions|parser functions]] or [[Help:Special characters|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: <code><nowiki><br></nowiki></code> for instance, is not automatically converted to {{tag|style=plain|br|single}} and missing {{tag|style=plain|td|close}} and {{tag|style=plain|tr|close}} 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 [[Template talk:Fmbox|the talk page]]. Since this template works in almost the same way as {{tl|Ambox}}, {{tl|Tmbox}}, {{tl|Imbox}}, {{tl|Cmbox}} and {{tl|Ombox}}, further information found on their talk pages may also be relevant.

===See also===
* {{tl|Fmbox warning ruler}}, a horizontal ruler, used within some system warning notices, that uses the same red as this template's {{mono|warning}} type.

{{Mbox templates see also}}

<includeonly>{{Sandbox other|
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Mbox and messagebox templates]]
}}</includeonly>