Template:Ombox/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Sperxios
Add forgotten Template:lua sign.
Ookami (talk | contribs)
m 170 revisions imported
 
(53 intermediate revisions by 38 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
{{high-risk|280,000+}}
{{High-use| 711490 }}
{{lua|Module:Message box}}
{{used in system}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:Message box}}
{{mbox templates}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
This is the {{tl|ombox}} or '''other pages message box''' meta-template.
{{Mbox templates (small)}}


It is used to build message box templates for pages of the types: User, Wikipedia, MediaWiki, Template, Help, Portal and any new future namespaces. That is, 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 is the {{tl|Ombox}} (['''O''']ther pages ['''m''']essage ['''box''']) metatemplate.


This template works almost exactly like {{tl|ambox}} and uses the same parameters.
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.


=== We are deploying! ===
This template works almost exactly like {{tl|Ambox}} and uses the same parameters.
After discussions on the [[Template talk:Ombox|talk page]] of this template and announcing it at several places for some time we are now deploying this template. 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.
 
=== 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.
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.
Line 19: Line 22:


<pre>
<pre>
{{ombox | text = Some text.}}
{{ombox
| text     = Some text.
}}
</pre>
</pre>


Line 30: Line 35:
{{ombox
{{ombox
| type      = style
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| image    = [[File:Emblem-question-yellow.svg|40px]]
| style    = width: 400px;  
| style    = width: 400px;  
| textstyle = color: red; font-weight: bold; font-style: italic;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 39: Line 44:
{{ombox
{{ombox
| type      = style
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| image    = [[File:Emblem-question-yellow.svg|40px]]
| style    = width: 400px;  
| style    = width: 400px;  
| textstyle = color: red; font-weight: bold; font-style: italic;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 59: Line 64:
{{ombox
{{ombox
| type = content
| type = content
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|high-risk}}.
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|high-use}}.
}}
}}
{{ombox
{{ombox
| type = style
| type = style
| text = type=<u>style</u> – Minor warnings and problems. {{tl|intricate}} should perhaps use this type.
| text = type=<u>style</u> – Minor warnings and problems. {{tl|Intricate template}} should perhaps use this type.
}}
}}
{{ombox
{{ombox
| type = notice
| 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}}.
| 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
{{ombox
Line 75: Line 80:
{{ombox
{{ombox
| type = protection
| type = protection
| text = type=<u>protection</u> – Protection templates such as {{tl|pp-protected}} when shown on "other pages".
| text = type=<u>protection</u> – Protection templates such as {{tl|pp}} when shown on "other pages".
}}
}}


Line 89: Line 94:
}}
}}
{{ombox
{{ombox
| image = [[Image:Gnome globe current event.svg|42px]]
| image = [[File:Gnome globe current event.svg|42px]]
| imageright = [[Image:Nuvola apps bookcase.svg|40px]]
| imageright = [[File:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[Image:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki>
| text  = image = <nowiki>[[File:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
}}


{{ombox
{{ombox
| type      = notice
| type      = notice
| image      = [[Image:Blue check.svg|30px]]
| image      = [[File:Blue check.svg|30px]]
| imageright = {{shortcut|WP:SHORT}}
| imageright = {{shortcut|WP:SHORT}}
| text      =  
| text      =  
Line 103: Line 108:
{{ombox
{{ombox
| type      = notice
| type      = notice
| image      = [[Image:Nutshell.png|30px]]
| image      = [[File:Nutshell.png|30px]]
| text      =  
| 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.
'''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 113: Line 118:
<pre>
<pre>
{{ombox
{{ombox
| name = name of the template
| type  = speedy / delete / content / style / notice / move / protection
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Image:Some image.svg|40px]]
| image = none / [[File:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| imageright = [[File:Some image.svg|40px]]
| style = CSS values
| style = CSS values
| textstyle = CSS values
| textstyle = CSS values
| plainlinks = no
| text  = The message body text.  
| text  = The message body text.  
| small = {{{small|}}} / yes
| small = {{{small|}}} / yes
| smallimage = none / [[Image:Some image.svg|30px]]
| smallimage = none / [[File:Some image.svg|30px]]
| smallimageright = none / [[Image:Some image.svg|30px]]
| smallimageright = none / [[File:Some image.svg|30px]]
| smalltext  = A shorter message body text.
| smalltext  = A shorter message body text.
}}
}}
</pre>
</pre>
'''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'''
'''type'''
Line 132: Line 142:
:'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.  
:'''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:  
:'''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 = [[Image:Crystal package settings.png|40px]]</nowiki></code>
::<code><nowiki>image = [[File:Crystal package settings.png|40px]]</nowiki></code>
:'''none''' = Means that no image is used.
:'''none''' = Means that no image is used.


Line 138: Line 148:
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
:'''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:  
:'''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 = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''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.


Line 148: Line 158:
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = text-align: center;</code>
::<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'''
'''text'''
Line 168: Line 181:
{{ombox
{{ombox
| small = yes
| small = yes
| image      = [[Image:Replacement filing cabinet.svg|50px]]
| image      = [[File:Replacement filing cabinet.svg|50px]]
| smallimage = [[Image:Replacement filing cabinet.svg|32px]]
| smallimage = [[File:Replacement filing cabinet.svg|32px]]
| text =  
| text =  
small = yes <br> image = <nowiki>[[Image:Replacement filing cabinet.svg|50px]]</nowiki> <br> smallimage = <nowiki>[[Image:Replacement filing cabinet.svg|32px]]</nowiki>
small = yes <br> image = <nowiki>[[File:Replacement filing cabinet.svg|50px]]</nowiki> <br> smallimage = <nowiki>[[File:Replacement filing cabinet.svg|32px]]</nowiki>
}}
}}
'''smallimage'''
'''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.
:'''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:  
:'''An image''' = Should be an image with usual wiki notation. 30px width is usually about right. For example:  
::<code><nowiki>smallimage = [[Image:Replacement filing cabinet.svg|30px]]</nowiki></code>
::<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".
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes".


{{ombox
{{ombox
| small = yes
| small = yes
| imageright = [[Image:Nuvola apps bookcase.png|50px]]
| imageright = [[File:Nuvola apps bookcase.png|50px]]
| smallimageright = none
| smallimageright = none
| text =  
| text =  
small = yes <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.png|50px]]</nowiki> <br> smallimageright = none
small = yes <br> imageright = <nowiki>[[File:Nuvola apps bookcase.png|50px]]</nowiki> <br> smallimageright = none
}}
}}
'''smallimageright'''
'''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.
:'''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:  
:'''An image''' = Should be an image with usual wiki notation. 30px width is usually about right. For example:  
::<code><nowiki>smallimageright = [[Image:Nuvola apps bookcase.png|30px]]</nowiki></code>
::<code><nowiki>smallimageright = [[File:Nuvola apps bookcase.png|30px]]</nowiki></code>
:'''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.
:'''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".
Line 217: Line 230:
}}
}}


This template uses the ombox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
This template uses the ombox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.  
 
This template calls {{tl|ombox/core}} which holds most of the code for {{tl|ombox}}, while {{tl|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 [[m:Help:ParserFunctions|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.
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 227: Line 236:
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.
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 ===
===See also===
{{Mbox templates see also}}
{{Mbox templates see also}}


{{mbox template family}}
<includeonly>{{Sandbox other|
 
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[Category:Mbox and messagebox templates]]
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Exclude in print]]
[[Category:Exclude in print]]
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
}}</includeonly>
}}</includeonly>

Latest revision as of 04:49, 3 September 2020

Message box
meta-templates
templatecontext
{{Ambox}}article
{{Cmbox}}category
{{Imbox}}image
{{Tmbox}}talk
{{Fmbox}}footer / header
{{Ombox}}other pages
{{Mbox}}auto-detect
{{Asbox}}article stub
{{Dmbox}}disambiguation

This is the {{Ombox}} ([O]ther pages [m]essage [box]) 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 {{Ambox}}, {{Tmbox}}, {{Imbox}} or {{Cmbox}}. Thus, it should not be used for boxes for articles, talk pages, image pages or category pages.

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

Introduction

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:

{{ombox
| text      = Some text.
}}

Complex example:

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

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.

Examples

Some examples using the "notice" style:

Parameters

List of all parameters:

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

name

(Optional) Name of the template. This adds a CSS class with name box-name 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:
image = [[File: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 = [[File: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;

plainlinks

Normally on Wikipedia, external links have an arrow icon next to them, like this: Example.com. However, in message boxes, the arrow icon is suppressed by default, like this: Example.com. To get the normal style of external link with the arrow icon, use |plainlinks=no.

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:
small = {{{small|}}}

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 = [[File:Replacement filing cabinet.svg|30px]]
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:
smallimageright = [[File: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

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

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

See also

There are seven metatemplates in the Module:Message box family:
  • {{Ambox}}, for messageboxes on article pages.
  • {{Cmbox}}, for messageboxes on category pages.
  • {{Imbox}}, for messageboxes on file (image) pages.
  • {{Tmbox}}, for messageboxes on talk pages.
  • {{Fmbox}}, for header and footer messageboxes.
  • {{Ombox}}, for messageboxes on other types of page.
  • {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.

Closely related metatemplates:

  • {{Asbox}}, for messageboxes in article stubs.
  • {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
  • {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.

Templates intended to be used in conjunction with Mboxes: