Předłoha:Cmbox/Dokumentacija

z Kitakija

Wersija z 19:20, 22. awg 2008

To je {{cmbox}} abo zdźělenski kašćik za kategorije (jendźelsce category message box) wot typa meta-předłoha.

Wona so wužiwa zo by wutworiła předłohi za zdźělenske kašćiki za kategorijowe strony, tajka kaž {{Rozrjaduj kategoriju}} atd. Poskića někotre rozdźělne barby, wužiwa standardne wobrazy, jeli žadyn parameter image njeje definowany a ma někotre druhe znamjenja.

Tuta předłoha funguje zwjetša dokładnje kaž {{ambox}} a wužiwa nimale samsne parametry.

Wužiće

Jednory přikład:

{{cmbox | text = Někajki tekst.}}

Kompleksny přikład

{{cmbox
| type      = style
| image     = [[Image:Emblem-question-yellow.svg|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = Wobłuk za zdźělenski tekst.

}}

Typy zdźělenskich kašćikow za kategorije

Sćěhowace přikłady wužiwaja rozdźělne parametry type, ale njewužiwaja parametry image, tak zo standardne wobrazy za kóždy typ wužiwać.

Druhe wobrazy

Standardne wobrazy, kotrež so horjeka pokazuja, su zwjetša přihódnosće dla. We wjele padach je přihódnišo bóle specifiske wobrazy wužiwać. Tute přikłady wužiwaja parameter image, zo by druhe wobrazy hač standardne wobrazy definowali.

Specialne

Někotre kombinacije parametrow

Parametry

Lisćina wšěch parametrow:

{{cmbox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| textstyle = CSS value
| text  = Zdźělenski tekst. 

}}

type

Jeli žadyn type parameter njeje definowany, to předłohowe předskoki za typ notica, kotryž so za "nastawkowe noticy" wužiwa. To woznamjenja, zo so pokaza módry "side bar" kaž w přikładźe z jednorym wužićom předłohi horjeka.

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 = [[Image:Sub-arrows.svg|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 on this side 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

An optional CSS value used by the entire message box table. Without quotation marks " ". For example:

style = margin-bottom: 0.5em;

textstyle

An optional CSS value used by the text cell. For example:

textstyle = text-align: center;

text

The message body text.

Technical details

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

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

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}} and {{imbox}} their talk pages and related pages might also contain more details.

See also

There are several meta-templates in the mbox family:

• {{ambox}} (Za zdźělenki we mjenowym rumje nastawkow (jendźelsce article message box))
• {{tmbox}} (za zdźělenki we mjenowym rumje Diskusija: (jendźelsce discussion message box))
• {{imbox}} (za zdźělenki we mjenowym rumje Wobraz (jendźelsce image message box))
• {{cmbox}} (za zdźělenki we mjenowym rumje Kategorija (jendźelsce category message box))
• {{ombox}} (za zdźělenki na dalšich stronach)
• {{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.