Template:Ombox/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
m
84 revisions imported
m (Reverted edits by 107.77.208.6 (talk) (HG) (3.1.22)) |
m (84 revisions imported) |
||
| (31 intermediate revisions by 20 users not shown) | |||
Line 1:
{{Documentation subpage}}
{{used in system}}
{{Lua|Module:Message box}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{Mbox templates (small)}}
Line 14 ⟶ 12:
=== Introduction ===
{{anchor|We are deploying!|Intro}}
As noted above, this template should be used for message boxes that are not articles, talk pages, image pages or category pages. Some message boxes for other pages may incorrectly use one of those four mentioned. 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.
Line 23 ⟶ 21:
<pre>
{{ombox
| text = Some text.
}}
</pre>
Line 34:
{{ombox
| type = style
| image = [[
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 43:
{{ombox
| type = style
| image = [[
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 63:
{{ombox
| type = content
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|high-
}}
{{ombox
| type = style
| text = type=<u>style</u> – Minor warnings and problems. {{tl|
}}
{{ombox
| type = notice
| text = type=<u>notice</u> – Notices and messages of any kind, both permanent and temporary. Such as {{tl|guideline}} and {{tl|Wikipedia how
}}
{{ombox
Line 79:
{{ombox
| type = protection
| text = type=<u>protection</u> – Protection templates such as {{tl|pp
}}
Line 93:
}}
{{ombox
| image = [[
| imageright = [[
| text = image = <nowiki>[[
}}
{{ombox
| type = notice
| image = [[
| imageright = {{shortcut|WP:SHORT}}
| text =
Line 107:
{{ombox
| type = notice
| image = [[
| text =
'''This page in a nutshell:''' This template is used to build message boxes for all pages that are ''not'' articles, talk pages, image pages or category pages.
Line 115:
List of all parameters:
<syntaxhighlight lang="moin">
{{ombox
| name = name of the template
| type = speedy / delete / content / style / notice / move / protection
| image = none / [[
| imageright = [[
| style = CSS values
| textstyle = CSS values
Line 125 ⟶ 126:
| text = The message body text.
| small = {{{small|}}} / yes
| smallimage = none / [[
| smallimageright = none / [[
| smalltext = A shorter message body text.
}}
</syntaxhighlight>
'''name'''
:(Optional) Name of the template. This adds a CSS class with name <code>box-''name''</code> to the HTML element, for use by bots or scripts.
'''type'''
Line 137 ⟶ 141:
:'''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:
::<code><nowiki>image = [[
:'''none''' = Means that no image is used.
Line 143 ⟶ 147:
:'''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:
::<code><nowiki>imageright = [[
:'''Anything''' = Any other object that you want to show on the right side.
Line 176 ⟶ 180:
{{ombox
| small = yes
| image = [[
| smallimage = [[
| text =
small = yes <br> image = <nowiki>[[
}}
'''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:
::<code><nowiki>smallimage = [[
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes".
{{ombox
| small = yes
| imageright = [[
| smallimageright = none
| text =
small = yes <br> imageright = <nowiki>[[
}}
'''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:
::<code><nowiki>smallimageright = [[
:'''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".
Line 207 ⟶ 211:
If you need to use special characters in the text parameter then you need to escape them like this:
<syntaxhighlight lang="tid">
{{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
And now a pipe and end braces
</div>
}}
</syntaxhighlight>
{{ombox
Line 225 ⟶ 229:
}}
This template uses the ombox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
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.
Line 238:
{{Mbox templates see also}}
<includeonly>{{
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Mbox and messagebox templates]]
| |||
