Teamplaid:Ombox/documentation

Message box meta-templates
{{Ambox}} {{Cmbox}} {{Imbox}} {{Mbox}} {{Ombox}} {{Tmbox}} {{Asbox}} {{Dmbox}} {{Fmbox}}

This is the {{Ombox}} or other pages message box meta-template.

It is used to build message box templates for pages of the types: User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces. That is, page types not covered by {{Ambox}}, {{Tmbox}}, {{Imbox}} or {{Cmbox}}. Thus it should not be used for boxes for articles, talk pages, image pages or category pages.

This template works almost exactly like {{Ambox}} and uses the same parameters.

We are deploying!

After discussions on the talk page of this template and announcing it at several places for some time we are now deploying this template. Feel free to convert any message boxes used on "other pages" to use this meta-template. If you find any tricky cases then list them on the talk page of this template and you'll get help.

When this template is used to build other pages message boxes those boxes should contain explanatory texts just like before. (The same texts as before or new improved texts.) If there are more specific images in the boxes or you know a better image, then use them instead of the default images shown here.

Ùsaid - Usage

Simple usage example:

{{Ombox | text = Some text.}}

Complex example:

{{Ombox
| type      = style
| image     = [[Faidhle:Emblem-question-yellow.svg|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

Other pages message box types

The following examples use different type parameters but use no image parameters thus they use the default images for each type.

Eisimpleirean - Examples

Some examples using the "notice" style:

Paramadairean - Parameters

List of all parameters:

{{Ombox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Faidhle:Some image.svg|40px]]
| imageright = [[Faidhle:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 
| small = {{{small|}}} / yes
| smallimage = none / [[Faidhle:Some image.svg|30px]]
| smallimageright = none / [[Faidhle:Some image.svg|30px]]
| smalltext  = A shorter message body text.
}}

type

If no type parameter is given the template defaults to type notice. That means it gets a gray border.

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:

image = [[Faidhle:Crystal package settings.png|40px]]

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:

imageright = [[Faidhle: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

small

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

small = {{{small|}}}

smallimage

No parameter = If no smallimage parameter is given then this template falls back to use the image parameter. If the image parameter also is empty then a small default image is used.

An image = Should be an image with usual wiki notation. 30px width is usually about right. For example:

smallimage = [[Faidhle:Replacement filing cabinet.svg|30px]]

none = Means that no image is used. This overrides any image fed to image, when "small=yes".

smallimageright

No parameter = If no smallimageright parameter is given then this template falls back to use the imageright parameter. If the imageright parameter also is empty then no image is shown on the right side.

An image = Should be an image with usual wiki notation. 30px width is usually about right. For example:

smallimageright = [[Faidhle:Nuvola apps bookcase.png|30px]]

Anything = Any other object that you want to show on the right side.

none = Means that no right side image is used. This overrides any image fed to imageright, when "small=yes".

smalltext

A shorter version of the message body text. If no smalltext parameter is given then this template falls back to use the text parameter.

Mion-fhiosrachadh teicnigeach - Technical details

If you need to use special characters in the text parameter then you need to escape them like this:

{{Ombox
| 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 template uses the Ombox CSS classes in MediaWiki:Common.css for most of its looks, thus it is fully skinnable.

This template calls {{Ombox/core}} which holds most of the code for {{Ombox}}, while {{Ombox}} itself does parameter preprocessing.

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.

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.

For more technical details see the talk page. Since this template works almost exactly like {{Ambox}}, {{Tmbox}}, {{Imbox}} and {{Cmbox}} their talk pages and related pages might also contain more details.

Faic cuideachd - Also see

There are seven meta-templates in the Module:Message box family:

• {{Ambox}} – For article message boxes.
• {{Cmbox}} – For category message boxes.
• {{Imbox}} – For file (image) page message boxes.
• {{Fmbox}} – For header and footer 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.
• {{Ombox}} – For other pages message boxes.
• {{Tmbox}} – For talk page message boxes.

Closely related meta-templates:

• {{Asbox}} – For article stub message boxes.
• {{Dmbox}} – For disambiguation and set index message boxes.
• {{Ivmbox}} – A simplistic, full-width box intended to surround important messages or notices, with an ivory background by default.