Template:Fmbox/doc: Difference between revisions

From AIE Wiki
Jump to navigation Jump to search
No edit summary
 
m (4 revisions)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
<noinclude>{{Documentation subpage}}</noinclude>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PUT HERE THE DOCUMENTATION -->
== Parameters ==
{| class="wikitable"
|-
! Parameter
! Options
! Notes
|-
| type
| warning/editnotice/system
|-
| class
|
| Additional CSS styling for the message box (pulled from another stylesheet ([[Mediawiki:Common.css]])
|-
| style
|
| Additional CSS styling for the message box (manually declared)
|-
| image
| <code><nowiki>[[File:example.example|40px]]</nowiki></code>
| If bank, Auto detected and chosen by <code>type</code>.
Default images:
* warning: [[:File:Cmbox deletion.png]]
* editnotice: [[:File:Imbox notice.png]]
* (default)/system: [[:File:Imbox notice.png]]
|-
| textstyle
|
| CSS formatting for the displayed text
|-
| text
|
| The message to be displayed
|-
| imageright
| <code><nowiki>[[File:example.example|40px]]</nowiki></code>
| File to be shown on the right side of the message
|}
=== Example messages ===
{| class="wikitable"
|-
! Message type
! Code
! Example output
|-
| (default)
| <pre>{{Fmbox
|type =
|text = Example message text.
}}</pre>
| {{Fmbox |type= |text=Example message text.}}
|-
| warning
|
<pre>{{Fmbox
|type = warning
|text = Example message text.
}}</pre>
|  {{Fmbox |type=warning |text=Example message text.}}
|-
| editnotice
|
<pre>{{Fmbox
|type = editnotice
|text = Example message text.
}}</pre>
| {{Fmbox |type=editnotice |text=Example message text.}}
|-
| system
|
<pre>{{Fmbox
|type = system
|text = Example message text.
}}</pre>
| {{Fmbox |type=system |text=Example message text.}}
|}


{{mbox templates}}
<includeonly>
This is the {{tl|fmbox}} or '''footer & header message box''' template.
<!-- PUT HERE THE CATEGORIES OF THE TEMPLATE -->
 
[[Category:Info templates|{{PAGENAME}}]]
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]].
</includeonly>
 
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.
 
=== Usage ===
 
Simple usage example:
 
<pre>
{{fmbox | text = Some text.}}
</pre>
 
{{fmbox | text = Some text.}}
 
 
Complex example:
 
<pre>
{{fmbox
| type      = editnotice
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}
</pre>
 
{{fmbox
| type = editnotice
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}
 
=== Footer and header message box types ===
 
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.
 
{{fmbox
| type = warning
| text = type=<u>warning</u> – System warning notices such as [[MediaWiki:Revision-info]] and [[MediaWiki:Protectedpagewarning]].
}}
 
{{fmbox
| type = editnotice
| text = type=<u>editnotice</u> – Transparent background for [[Wikipedia:Editnotice|editnotices]].
}}
 
{{fmbox
| type = system
| text = type=<u>system</u> – Light grey system message background (default).
}}
 
=== Other 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. These examples use the '''image''' parameter to specify an image other than the default image.
 
{{fmbox
| image = [[Image:User-info.svg|40px]]
| text  = image = <nowiki>[[Image:User-info.svg|40px]]</nowiki> <br> This image is used for [[MediaWiki:Sp-contributions-footer]].
}}
{{fmbox
| image = [[Image:Commons-logo.svg|40x40px]]
| text  = image = <nowiki>[[Image:Commons-logo.svg|40x40px]]</nowiki> <br> Note the use of "40x40px" to also limit the height of the image. This image is used for [[MediaWiki:Sharedupload-desc-here]].
}}
 
=== Special ===
 
Some other parameter combinations.
 
{{fmbox
| text  = Default image given (no '''image=''' specified)
}}
{{fmbox
| image = none
| text  = '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
{{fmbox
| image = [[Image:User-info.svg|40px]]
| imageright = [[Image:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[Image:User-info.svg|40px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
 
=== Parameters ===
 
List of all parameters:
 
<pre>
{{fmbox
| 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
| text  = The message body text.
}}
</pre>
 
'''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>
 
'''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 the {{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 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>.
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
</div>
}}
</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 <nowiki>}}</nowiki>.
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}
 
Internally this meta-template uses HTML wikimarkup instead of wikimarkup for the table code. That is the usual way we make meta-templates since wikimarkup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and some special characters in parameters.
 
The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons.
 
'''Note to admins:''' MediaWiki does not parse and convert HTML wikimarkup in system messages the same way as it does for normal pages. This means for instance that <code>&lt;br></code> is not automatically converted to <code>&lt;br /></code> and missing <code>&lt;/td></code> and <code>&lt;/tr></code> 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 [[Template talk:Fmbox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details.
 
=== See also ===
* {{tl|fmbox warning ruler}} – A horizontal ruler in the same colour as the red border for the warning type. Used inside some system warning notices.
 
{{Mbox templates see also}}
 
{{mbox template family}}
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:MediaWiki metatemplates|{{PAGENAME}}]]
 
}}</includeonly>

Latest revision as of 13:56, 28 August 2013

File:Edit-copy green.svg This is a documentation subpage for Template:Fmbox (see that page for the template itself).
It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

Parameters

Parameter Options Notes
type warning/editnotice/system
class Additional CSS styling for the message box (pulled from another stylesheet (Mediawiki:Common.css)
style Additional CSS styling for the message box (manually declared)
image [[File:example.example|40px]] If bank, Auto detected and chosen by type.

Default images:

textstyle CSS formatting for the displayed text
text The message to be displayed
imageright [[File:example.example|40px]] File to be shown on the right side of the message

Example messages

Message type Code Example output
(default) 
{{Fmbox
|type =
|text = Example message text.
}}
Example message text.
warning 
{{Fmbox
|type = warning
|text = Example message text.
}}
File:Cmbox deletion.png Example message text.
editnotice 
{{Fmbox
|type = editnotice
|text = Example message text.
}}
Example message text.
system 
{{Fmbox
|type = system
|text = Example message text.
}}
Example message text.


Retrieved from "https://wiki.aie-guild.org/index.php?title=Template:Fmbox/doc&oldid=24637"