ထႅမ်းပလဵတ်ႉ:Ombox/doc

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, Wikibooks, MediaWiki, Template, Help, Subject, 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.

လွင်ႈၸႂ်ႉတိုဝ်း

Simple usage example:

{{Ombox | text = Some text.}}

Complex example:

{{Ombox
| type      = style
| image     = [[ၾၢႆႇ:Emblem-question-yellow.svg|40px|link=]]
| 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.

တူဝ်ယၢင်ႇ

Some examples using the "notice" style:

ပႃႇရႃႇမီႇတႃႇ

List of all parameters:

{{Ombox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[ၾၢႆႇ:Some image.svg|40px]]
| imageright = [[ၾၢႆႇ:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 
| small = {{{small|}}} / yes
| smallimage = none / [[ၾၢႆႇ:Some image.svg|30px]]
| smallimageright = none / [[ၾၢႆႇ: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 = [[ၾၢႆႇ: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 = [[ၾၢႆႇ: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 = [[ၾၢႆႇ: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 = [[ၾၢႆႇ: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.

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 မီႇတီႇယႃႇဝီႇၶီႇ:Common.css/Mboxes.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.

တူၺ်းပႃး

There are several meta-templates in the mbox family:

• {{Ambox}} – For article message boxes.
• {{Tmbox}} – For talk page message boxes.
• {{Imbox}} – For file (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.

Closely related meta-templates:

• {{Fmbox}} – For header and footer message boxes.