Vorlage:Fmbox/Doku: Unterschied zwischen den Versionen

K
61 Versionen von wikivoyage:Vorlage:Fmbox/Doku importiert
imported>Davidgothberg
(Added "Note to admins" about HTML vs XHTML in system messages.)
K (61 Versionen von wikivoyage:Vorlage:Fmbox/Doku importiert)
 
(56 dazwischenliegende Versionen von 34 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{Documentation subpage}}
{{Dokumentation Unterseite}}
{{high-risk}}
{{Lua|Modul:Message box}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{mbox templates}}
{{mbox templates}}
This is the {{tl|fmbox}} or '''header & footer message box''' template.
This is the {{tl|fmbox}} or '''footer & header 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.
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 [[w:en:Wikipedia:Editnotice|editnotices]].


This template works similarly to {{tl|ambox}} and mostly uses the same parameters. The main difference is that this box is 100% wide and only has one colour style.
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 ===
=== Usage ===
Zeile 23: Zeile 26:
<pre>
<pre>
{{fmbox
{{fmbox
| type      = editnotice
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = background: transparent;
| style    = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
| text      = The message body text.
Zeile 31: Zeile 35:


{{fmbox
{{fmbox
| type = editnotice
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = background: transparent;
| style    = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
| 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 [[w:en:Wikipedia:Editnotice|editnotices]].
}}
{{fmbox
| type = system
| text = type=<u>system</u> – Light grey system message background (default).
}}
}}


=== Other images ===
=== Other images ===


The default image shown above is 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.
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
{{fmbox
Zeile 47: Zeile 71:
{{fmbox
{{fmbox
| image = [[Image:Commons-logo.svg|40x40px]]
| 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]].
| 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]].
}}
}}


Zeile 55: Zeile 79:


{{fmbox
{{fmbox
| text  = No type and no image given ('''default''')
| text  = Default image given (no '''image=''' specified)
}}
}}
{{fmbox
{{fmbox
| image = none
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
| text  = '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
}}
{{fmbox
{{fmbox
Zeile 72: Zeile 96:


<pre>
<pre>
{{imbox
{{fmbox
| type  = system / editnotice / warning
| image = none / [[Image:Some image.svg|40px]]
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| id = CSS id
| textstyle = CSS value
| class = CSS class names
| style = CSS values
| textstyle = CSS values
| text  = The message body text.
| text  = The message body text.
}}
}}
</pre>
</pre>
'''type'''
:If no '''type''' parameter is given the template defaults to type '''system'''. That means it gets a light grey background.


'''image'''
'''image'''
:'''No parameter''' = If no '''image''' parameter is given the template uses its default 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:  
:'''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>
::<code><nowiki>image = [[Image:User-info.svg|40px]]</nowiki></code>
Zeile 92: Zeile 122:
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.
:'''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'''
'''style'''
:An optional [[Cascading Style Sheets|CSS]] value used by the entire message box table. Without quotation marks <code>" "</code>. For example:
: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>
::<code>style = margin-top: 1em;</code>


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


Zeile 106: Zeile 144:
=== Technical details ===
=== Technical details ===


This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned.
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:  
If you need to use special characters in the text parameter then you need to escape them like this:  
Zeile 128: Zeile 168:
}}
}}


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


'''Note to admins:''' MediaWiki does not parse and convert HTML 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.
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.
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 ===
* {{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.


There are several meta-templates in the mbox family:
{{Mbox templates see also}}
* {{tl|ambox}} – For article message boxes.
 
* {{tl|tmbox}} – For talk page message boxes.
{{mbox template family}}
* {{tl|imbox}} – For image page message boxes.
* {{tl|cmbox}} – For category message boxes.
* {{tl|ombox}} – For other pages message boxes.
* {{tl|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.
* {{tl|fmbox}} – For header and footer message boxes.


<includeonly>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Kategorie:Vorlagen:Infoboxen]]
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
 
</includeonly>
</includeonly>