Jump to content

Template:Wb/lad/Ombox/doc

From Wikimedia Incubator

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.

This is the {{Wb/lad/ombox}} or other pages message box meta-template.

It is used to build message box templates for pages of the types: User, Wikibooks, MediaWiki, Template, Help, Subject, and any new future namespaces. That is, page types not covered by {{Wb/lad/ambox}}, {{Wb/lad/tmbox}}, {{Wb/lad/imbox}} or {{Wb/lad/cmbox}}. Thus it should not be used for boxes for articles, talk pages, image pages or category pages.

This template works almost exactly like {{Wb/lad/ambox}} and uses the same parameters.

Simple usage example:

{{ombox | text = Some text.}}

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.


Complex example:

{{ombox
| type      = style
| image     = [[File:Emblem-question-yellow.svg|40px|link=]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.

Other pages message box types

[edit source]

The following examples use different type parameters but use no image parameters thus they use the default images for each type.

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.

Examples

[edit source]

Some examples using the "notice" style:

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.

Parameters

[edit source]

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

[edit source]

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. 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|}}}

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. 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".

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found. 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

[edit source]

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>
}}

Lua error in package.lua at line 80: module 'Module:Wb/lad/Arguments' not found.

This template uses the ombox CSS classes in MediaWiki:Common.css/Mboxes.css for most of its looks, thus it is fully skinnable.

This template calls {{Wb/lad/ombox/core}} which holds most of the code for {{Wb/lad/ombox}}, while {{Wb/lad/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.

See also

[edit source]

There are several meta-templates in the mbox family:

  • {{Wb/lad/ambox}} – For article message boxes.
  • {{Wb/lad/tmbox}} – For talk page message boxes.
  • {{Wb/lad/imbox}} – For file (image) page message boxes.
  • {{Wb/lad/cmbox}} – For category message boxes.
  • {{Wb/lad/ombox}} – For other pages message boxes.
  • {{Wb/lad/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.

Closely related meta-templates: