View source for Template:Ombox/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Cascade-protected template}}
{{used in system}}
{{Lua|Module:Message box}}

{{Mbox templates (small)}}

This is the {{tl|Ombox}} (['''O''']ther pages ['''m''']essage ['''box''']) [[WP:MTM|metatemplate]].

It is used to build message box templates for pages of the types User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces; i.e. for page types not covered by {{tl|Ambox}}, {{tl|Tmbox}}, {{tl|Imbox}} or {{tl|Cmbox}}. Thus, it should ''not'' be used for boxes for articles, talk pages, image pages or category pages.

This template works almost exactly like {{tl|Ambox}} and uses the same parameters.

=== 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.

When this template is used to build other pages message boxes those boxes should contain explanatory texts just like before. (The same texts as before or new improved texts.) If there are more specific images in the boxes or you know a better image, then use them instead of the default images shown here.

=== Usage ===
Simple usage example:

<syntaxhighlight lang="wikitext">
{{ombox
| text      = Some text.
}}
</syntaxhighlight>

{{ombox | text = Some text.}}
{{clear}}

Complex example:

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

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

=== 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.

{{ombox
| type = speedy
| text = type=<u>speedy</u> – Speedy deletion templates.
}}
{{ombox
| type = delete
| text = type=<u>delete</u> – Deletion templates.
}}
{{ombox
| type = content
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|high-use}}.
}}
{{ombox
| type = style
| text = type=<u>style</u> – Minor warnings and problems. {{tl|Intricate template}} should perhaps use this type.
}}
{{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-to}}.
}}
{{ombox
| type = move
| text = type=<u>move</u> – Merge, split, rename and transwiki messages and proposals.
}}
{{ombox
| type = protection
| text = type=<u>protection</u> – Protection templates such as {{tl|pp}} when shown on "other pages".
}}

=== Examples ===
Some examples using the "notice" style:

{{ombox
| text  = No type and no image given ('''default''')
}}
{{ombox
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
{{ombox
| image = [[File:Gnome globe current event.svg|42px]]
| imageright = [[File:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[File:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki>
}}

{{ombox
| type       = notice
| image      = [[File:Blue check.svg|30px]]
| imageright = {{shortcut|WP:SHORT}}
| text       = 
'''This page documents an English Wikipedia [[Wikipedia:Policies and guidelines|guideline]].''' It is a generally accepted standard that editors should follow, though it should be treated with [[Wikipedia:Use common sense|common sense]] and the [[Wikipedia:Ignore all rules|occasional exception]]. When editing this page, please ensure that your revision reflects [[Wikipedia:Consensus|consensus]]. When in doubt, discuss on the [[{{TALKPAGENAME}}|talk page]].
}}
{{ombox
| type       = notice
| image      = [[File:Nutshell.png|30px]]
| 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.
}}

=== Parameters ===
List of all parameters:

<syntaxhighlight lang="wikitext">
{{ombox
| name = name of the template
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[File:Some image.svg|40px]]
| imageright = [[File:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| plainlinks = no
| text  = The message body text. 
| small = {{{small|}}} / yes
| smallimage = none / [[File:Some image.svg|30px]]
| smallimageright = none / [[File:Some image.svg|30px]]
| 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'''
: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: 
::<code><nowiki>image = [[File:Crystal package settings.png|40px]]</nowiki></code>
:'''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: 
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''style'''
:Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-bottom: 0.5em;</code>

'''textstyle'''
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = text-align: center;</code>

'''plainlinks'''
:Normally on Wikipedia, external links have an arrow icon next to them, like this: [http://www.example.com Example.com]. However, in message boxes, the arrow icon is suppressed by default, like this: <span class="plainlinks">[http://www.example.com Example.com]</span>. To get the normal style of external link with the arrow icon, use {{para|plainlinks|no}}.

'''text'''
:The message body text.

==== The small parameters ====
{{ombox
| small = yes
| text = small = yes
}}
{{ombox
| type = style
| small = yes
| text = type = style <br> 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:
::<code><nowiki>small = {{{small|}}}</nowiki></code>

{{ombox
| small = yes
| image      = [[File:Replacement filing cabinet.svg|50px]]
| smallimage = [[File:Replacement filing cabinet.svg|32px]]
| text = 
small = yes <br> image = <nowiki>[[File:Replacement filing cabinet.svg|50px]]</nowiki> <br> smallimage = <nowiki>[[File:Replacement filing cabinet.svg|32px]]</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 = [[File:Replacement filing cabinet.svg|30px]]</nowiki></code>
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes".

{{ombox
| small = yes
| imageright = [[File:Nuvola apps bookcase.png|50px]]
| smallimageright = none
| text = 
small = yes <br> imageright = <nowiki>[[File:Nuvola apps bookcase.png|50px]]</nowiki> <br> 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: 
::<code><nowiki>smallimageright = [[File:Nuvola apps bookcase.png|30px]]</nowiki></code>
:'''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: 

<syntaxhighlight lang="wikitext">
{{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>
}}
</syntaxhighlight>

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

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.

For more technical details see the [[Template talk:Ombox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}} and {{tl|cmbox}} their talk pages and related pages might also contain more details.

===See also===
{{Mbox templates see also}}

<templatedata>
{
	"params": {
		"text": {
			"label": "Text of the box",
			"description": "The text to be displayed inside the box",
			"example": "Hello, I am a box created using {{ombox}}.",
			"type": "content",
			"required": true
		},
		"type": {
			"label": "Type of box to display",
			"description": "The type of box that will be displayed. Examples are \"speedy\", \"delete\", \"content\", \"style\", \"notice\", \"move\", and \"protection\".",
			"example": "notice",
			"type": "string",
			"suggestedvalues": [
				"speedy",
				"delete",
				"content",
				"style",
				"notice",
				"move",
				"protection"
			]
		},
		"image": {
			"label": "Image",
			"description": "The image to be displayed inside the box. This can be chosen automatically by setting the \"type\" parameter. Displays on the *left*. This should be given as a file wikilink, just as if you were adding an image on its own.",
			"example": "[[File:Some image.svg|40px]]",
			"type": "content"
		},
		"style": {
			"label": "CSS style for entire box",
			"description": "Inline CSS styles, which will be applied to the *entire* box.",
			"example": "text-align: center",
			"type": "string"
		},
		"textstyle": {
			"label": "CSS style for text",
			"description": "Inline CSS styles, which will only be applied to the text itself.",
			"example": "text-align: center",
			"type": "string"
		},
		"imageright": {
			"label": "Image to the right",
			"description": "The image to be displayed to the *right* of the text. This should be given as a file wikilink, just as if you were adding an image on its own.",
			"example": "[[File:Some image.svg|40px]]",
			"type": "content"
		},
		"plainlinks": {
			"label": "Plain external links?",
			"description": "In message boxes, external links have the arrow icon suppressed. Set this to \"no\" to restore the usual appearance of an external link.",
			"example": "no",
			"suggestedvalues": [
				"no"
			]
		},
		"small": {
			"label": "Small?",
			"description": "If set to \"yes\", the box becomes small.",
			"example": "yes",
			"suggestedvalues": [
				"yes"
			]
		},
		"smallimage": {
			"label": "Small image",
			"description": "A small image to be used. Displays on the left. Only use this parameter if \"small\" is set.",
			"example": "[[File:Some image.svg|30px]]"
		},
		"smallimageright": {
			"label": "Small image to the right",
			"description": "A small image to be used. Displays on the left. Only use this parameter if \"small\" is set.",
			"example": "[[File:Some image.svg|30px]]",
			"type": "content"
		},
		"smalltext": {
			"label": "Small text",
			"description": "Smaller text to display. Falls back to the \"text\" parameter if not used.",
			"example": "Hi, I'm a small box!",
			"type": "content"
		}
	},
	"description": "Other pages message box. This template is usually not used directly, but is more often used as a metatemplate to build other templates.",
	"paramOrder": [
		"text",
		"type",
		"image",
		"imageright",
		"style",
		"textstyle",
		"plainlinks",
		"small",
		"smallimage",
		"smallimageright",
		"smalltext"
	]
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Mbox and messagebox templates]]

}}</includeonly>