Template:Fmbox/doc: Difference between revisions
meta>Davidgothberg Starting out this documentation. (Intermediate save.) |
meta>Davidgothberg Adding "Technical details", and doing some box margin testing. |
||
| Line 1: | Line 1: | ||
{{fmbox | text = Some text.}} | |||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
| Line 37: | Line 38: | ||
}} | }} | ||
=== 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: | |||
<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> | |||
}} | |||
</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 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 [[m:Help:ParserFunctions|parser functions]] and special characters in parameters. | |||
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 === | === See also === | ||
| Line 54: | Line 83: | ||
</includeonly> | </includeonly> | ||
{{fmbox | text = Some text.}} | |||
Revision as of 21:38, 8 September 2008
 | Some text. |
 | This is a documentation subpage for Template:Fmbox. It may contain usage information, categories and other content that is not part of the original template page. |
Template:Mbox templates 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.}}
| 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.
}}
 | 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>
}}
| Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}. |
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.
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.
| Some text. |
