Template:Fmbox/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Sardanaphalus
→‎Parameters: replaced {{Parameter descriptions}} with TemplateData
meta>Edokter
Undo; this template never appears on VE-enabled pages.
Line 60: Line 60:


===Parameters===
===Parameters===
<templatedata>
{{Parameter descriptions/full
{"description": "",
| tablestyle = padding-bottom:0.25em;border-bottom:1px solid #aaa;
"params": {
| colheadings = border-bottom:1px solid #aaa;
  "type": {"description": "Either \"system\", \"editnotice\" or \"warning\". (The default \"system\" uses a light-grey background.)", "type": "string", "default": "system"},
| defaults = vertical-align:middle;
  "image": {"description": "Leave unset to use the default image for type; set as none for no image; or specify an image using standard File: syntax.\n(A width/height around 40px–50px is usually suitable.)", "type": "string", "default": "varies according to {{{type}}}"},
| type       | Either {{mono|system}}, {{mono|editnotice}} or {{mono|warning}}. | | {{mono|system}}{{padlsup|a}}
  "imageright": {"description": "For an(other) image at the righthand end of the message box. (As with {{{image}}}, specify using standard File: syntax.)", "type": "string", "default": "[no image]"},
| image     | Leave unset to use the default image for {{mono|type}}; set as {{mono|none}} for no image; or specify an image using [[Help:Files|standard File: syntax]].<br/>(A width/height around 40px–50px is usually suitable.) | | Varies according to {{mono|type}}
  "id": {"description": "Use to set an CSS id for the template (e.g. to facilitate its detection by javascript).\n[[MediaWiki:Sp-contributions-footer]], for example, uses: | id = sp-contributions-footer", "type": "string"},
| imageright | For an(other) image at the righthand end of the message box. (As above, specify using standard File: syntax.) | | [no image]
  "class": {"description": "To specify CSS class/es for the template.\n[[MediaWiki:Sp-contributions-footer]], for example, uses: | class = sp-contributions-footer", "type": "string"},
| id         | Use to set an [[Cascading Style Sheets|CSS]] [[Identifier (computer science)|id]] for the template (e.g. to facilitate its detection by [[javascript]]). | <nowiki>id = sp-contributions-footer</nowiki>{{padlsup|b}} | –
  "style": {"description": "To add CSS styling to the template.", "type": "string"},
| class     | To specify CSS class/es for the template. | <nowiki>class = sp-contributions-footer</nowiki>{{padlsup|b}} | –
  "textstyle": {"description": "To add CSS styling to the template's {{{text}}}.\nFor example: | textstyle = font-size:90%;text-align:center;", "type": "string"},
| style     | To add CSS styling to the template. | <nowiki>style = margin-top:1.0em;</nowiki> | –
  "text": {"description": "The text presented by the template.", "type": "content"}
| textstyle | To add CSS styling to the template's {{mono|text}}. | <nowiki>textstyle = font-size:90%;text-align:center;</nowiki> | –
} }
| text       | The text presented by the template. | | –
</templatedata>
}}
{{Br list |{{sup|a}} Light-grey background. |{{sup|b}} Used by [[MediaWiki:Sp-contributions-footer]].}}


===Technical details===
===Technical details===

Revision as of 21:48, 28 December 2014

Message box
meta-templates
templatecontext
{{Ambox}}article
{{Cmbox}}category
{{Imbox}}image
{{Tmbox}}talk
{{Fmbox}}footer / header
{{Ombox}}other pages
{{Mbox}}auto-detect
{{Asbox}}article stub
{{Dmbox}}disambiguation

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.

Usage

Simple example

{{Fmbox |text=Some text.}}

produces:

Complex example

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

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.

Other examples

Parameters

Template:Parameter descriptions/full Template:Br list

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: Template:Plaincode 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.

See also

  • {{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 metatemplates in the Module:Message box family:
  • {{Ambox}}, for messageboxes on article pages.
  • {{Cmbox}}, for messageboxes on category pages.
  • {{Imbox}}, for messageboxes on file (image) pages.
  • {{Tmbox}}, for messageboxes on talk pages.
  • {{Fmbox}}, for header and footer messageboxes.
  • {{Ombox}}, for messageboxes on other types of page.
  • {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.

Closely related metatemplates:

  • {{Asbox}}, for messageboxes in article stubs.
  • {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
  • {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.

Templates intended to be used in conjunction with Mboxes: