Template:Ombox

Template documentation

This documentation is transcluded from Template:Ombox/doc. (edit | history)

Wannan shi ne {{ombox}} ko sauran shafuffuka maganar akwati meta da template.

Ya gina fadakarwar akwati templates da shafukffukan irin: Maabuci, Wikipedia, MediaWiki, Template, Taimako, Portal da wani sabon nan gaba sunafagagensa. Da wani sabon nan gaba suna fagagensa {{ambox}}, {{tmbox}}, {{imbox}} ko {{cmbox}}. Don haka kada a yi amfani da su don akwatan da kayayyakin aiki, shafukan magana, iralin shafukffukan ko babin shafuffukan.

Wannan template aiki kusan kamar {{ambox}} da ke amfani da irin wannan parameters.

Muna tsugunar da!

Bayan tattaunawa kan shafin magana da wannan template kuma sanar da dama inda jima muna a tsugunar da wannan template. Kai mayar da jawabi adakokin amfani da su a kan "sauran shafuffuka" da su yi amfani da wannan meta-template. Idan wani tricky koyi da jerin su a kan shafin magana da wannan template, za ka sami taimako.

Sa'ad da wannan template ta saba ma gina wani shafi akwatai maganar waɗanda akwatuttukan su kunshi explanatory wasanninsu kamar a gaban. (Haka kuma wasanninsu kamar dā, ko sabuwar kyautata ilmin ajami.) Idan akwai mafi gaskiya sassaƙaƙƙun siffofi da sunduƙai ko ka san abin da yake mafi kyau, sai su yi amfani da tushe siffofi nuna nan.

Wajen al'ada

Zo da sauƙi wajen al'ada misali:

{{ombox | text = Wasu matanin.}}

Alal misali mussamman:

{{ombox
| type      = style
| image     = [[Image:Emblem-question-yellow.svg|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = Maganar mai matanin.
}}

Sauran shafukan adakan maganar nauoi

Kashegari da misalai daban-daban da irin parameters sai dai wani gunki parameters suka yi amfani da tushe siffofin kowane iri.

Examples

Some examples using the "notice" style:

Parameters

List of all parameters:

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

See also