Template:Ombox/doc/cs

Toto je metašablona Ombox ([O]ther pages [m]essage [box]).

Používá se k vytváření šablon zpráv pro stránky typu Uživatel, Wikipedie, MediaWiki, Šablona, Nápověda, Portál a jakékoli nové budoucí jmenné prostory; tj. pro typy stránek, které nepokrývají Ambox, Tmbox, Imbox nebo Cmbox. Proto by se neměla používat pro rámečky pro články, diskusní stránky, obrázkové stránky nebo stránky kategorií.

Tato šablona funguje téměř přesně jako Ambox a používá stejné parametry.

Úvod
Jak je uvedeno výše, tato šablona by se měla používat pro schránky zpráv, které nejsou články, diskusní stránky, stránky s obrázky nebo stránky kategorií. Některá pole zpráv pro jiné stránky mohou nesprávně používat jednu z těchto čtyř uvedených. Neváhejte převést všechna pole zpráv použitá na "jiných stránkách" na použití této metašablony. Pokud najdete nějaké složité případy, uveďte je na diskusní stránce této šablony a získáte pomoc.

Když se tato šablona použije k vytvoření schránek zpráv na jiných stránkách, tato pole by měla obsahovat vysvětlující texty stejně jako dříve. (Stejné texty jako dříve nebo nové vylepšené texty.) Pokud jsou v rámečcích konkrétnější obrázky nebo znáte lepší obrázek, použijte je místo zde zobrazených výchozích obrázků.

Používání
Jednoduchý příklad použití:

Komplexní příklad:

Jiné typy schránek zpráv
Následující příklady používají různé parametry type, ale nepoužívají žádné parametry obrázku. Proto používají výchozí obrázky pro každý typ.

příklady
Některé příklady používající styl "upozornění".:

Parametry
Seznam všech parametrů:

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:
 * none = Means that no image is used.
 * 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:
 * Anything = Any other object that you want to show on the right side.
 * 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:

textstyle
 * Optional CSS values used by the text cell. For example:

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:

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:
 * none = Means that no image is used. This overrides any image fed to image, when "small=yes".
 * 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:
 * 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".
 * 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:

&lt;/nowiki>. And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>. }}

. And now a pipe and end braces |}}. }}

This template uses the ombox CSS classes in  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.