Template:Ombox
![]() |
![]() | Uses Lua: |
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, Wikidata, MediaWiki, Template, Help and any new future namespaces. That is, page types not covered by {{Tmbox}}
or {{Cmbox}}
. Thus, it should not be used for boxes for talk or category pages.
Usage
Simple usage example:
{{ombox | text = Some text.}}
![]() | Some text. |
Complex example:
{{ombox
| type = style
| image = [[Image:Emblem-question-yellow.svg|40px]]
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text = The message body 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.
![]() | type=speedy – Speedy deletion templates. |
![]() | type=delete – Deletion templates. |
![]() | type=content – Major warnings and problems, such as {{High-risk}} . |
![]() | type=style – Minor warnings and problems. {{Intricate}} should perhaps use this type. |
![]() | type=notice – Notices and messages of any kind, both permanent and temporary. Such as {{Guideline}} and {{Wikipedia how to}} . |
![]() | type=move – Merge, split, rename and transwiki messages and proposals. |
![]() | type=protection – Protection templates such as {{Pp-protected}} when shown on "other pages". |
Examples
Some examples using the "notice" style:
![]() | No type and no image given (default) |
No type and image=none – No image is used and the text uses the whole message box area. |
![]() | image = [[Image:Gnome globe current event.svg|42px]] imageright = [[Image:Nuvola apps bookcase.svg|40px]] | ![]() |
![]() | This page documents an English Wikipedia guideline. It is a generally accepted standard that editors should follow, though it should be treated with common sense and the occasional exception. When editing this page, please ensure that your revision reflects consensus. When in doubt, discuss on the talk page. |
![]() | 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. |
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:Crystal128-configure.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 the message box can handle images of any size.) For example:
imageright = [[Image:Nuvola apps bookcase.svg|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 |
![]() | type = style small = yes |
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|}}}
![]() | small = yes image = [[Image:Replacement filing cabinet.svg|50px]] smallimage = [[Image:Replacement filing cabinet.svg|32px]] |
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".
![]() | small = yes imageright = [[Image:Nuvola apps bookcase.svg|50px]] smallimageright = none |
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.svg|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>
}}
![]() | 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 |}}. |
The above documentation is transcluded from Template:Ombox/doc (edit | history). Editors can experiment in this template's sandbox (create | mirror) and testcases (create) page. Please add categories to the /doc subpage. Subpages of this template. |