Welcome to Warhammer 40k - Lexicanum! Log in and join the community.

Difference between revisions of "Template:Mbox/doc"

From Warhammer 40k - Lexicanum
Jump to: navigation, search
(The small parameters)
(Parameters)
Line 53: Line 53:
 
| textstyle  = CSS values
 
| textstyle  = CSS values
 
| text  = The message body text.  
 
| text  = The message body text.  
| small = {{{small|}}} / left / yes
+
| small = {{{small|}}} / yes
| smallimage = none / [[File:Some image.png|30px]]
 
| smallimageright = none / [[File:Some image.png|30px]]
 
| smalltext  = A shorter message body text.
 
 
}}
 
}}
 
</pre>
 
</pre>

Revision as of 23:52, 22 June 2009

This is the {{mbox}} or message box meta-template.

This meta-template is used to build message box templates that are used on several types of pages and thus need to change style depending on what page they are used on.

Usage

Simple usage example:

{{mbox | text = Some text.}}


Complex example:

{{mbox
| type       = style
| small      = left
| image      = [[File:Eldar.png|40px]]
| smallimage = [[File:Eldar.png|20px]]
| textstyle  = color: lime; font-weight: bold; font-style: italic;
| text       = Text for a big box, for the top of articles.
| smalltext  = Text for the top of article sections.
}}

But you are not really supposed to use lime bold italic text.

Parameters

List of all parameters:

{{mbox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[File:Some image.svg|40px]]
| imageright = [[File:Some image.svg|40px]]
| style = CSS values
| textstyle  = CSS values
| text  = The message body text. 
| small = {{{small|}}} / yes
}}

Note: The small parameters only have effect when the template is on an article, talk page or an "other" page. Using the small parameters when they are not valid has no effect, but also does no harm.

type

If no type parameter is given the template defaults to type notice. That means it gets a blue side bar.

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. (Images over 52 pixels width will cause padding problems.) For example:
image = [[File:Unbalanced scales.svg|40px]]
none = Means that no image is used.
blank = This parameter is now deprecated. If you see it in use, change it to "image=none".

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. (Images over 52 pixels width will cause padding problems.) For example:
imageright = [[File:Nuvola apps bookcase.png|40px]]
Anything = Any other object that you want to show on the right side.

style

Optional CSS values used by the entire message box table. Without quotation marks " " but with the ending semicolons ;. For example:
style = margin-bottom: 0.5em;

textstyle

Optional CSS values used by the text cell. For example:
textstyle = text-align: center;

text

The message body text.

The small parameters

The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.

small

yes = Makes it a smaller left aligned message box (right aligned when used in template pages). This also makes the default images smaller. Note that any data fed to the smallimage, smallimageright and smalltext parameters is only used if "small=left". To make it so your template also understands the small parameter you can use this code:
small = {{{small|}}}