Saintapedia

Template:Ombox/doc: Difference between revisions

Template Discussion

Template:Ombox/doc (view source)

Revision as of 13:14, 5 September 2024

5,458 bytes added ,  5 September 2024
add
VisualWikitext
m (1 revision imported)
(add)
Line 1: Line 1:
This is the {{tl|ombox}} or '''other pages message box''' meta-template.
{{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}}


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.
{{Mbox templates (small)}}


This template works almost exactly like {{tl|ambox}} and uses the same parameters.
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, Draft, 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 ===
=== Usage ===
Simple usage example:
Simple usage example:


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


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


Complex example:
Complex example:


<pre>
<syntaxhighlight lang="wikitext">
{{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;
| text      = The message body text.
| text      = The message body text.
}}
}}
</pre>
</syntaxhighlight>


{{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;
| text      = The message body text.
| text      = The message body text.
}}
}}
{{clear}}


=== Other pages message box types ===
=== 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.
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.


{{ombox
{{ombox
Line 50: Line 65:
{{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|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 66: Line 81:
{{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".
}}
}}


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


Line 81: Line 95:
}}
}}
{{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 95: Line 109:
{{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 101: Line 115:


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


<pre>
<syntaxhighlight lang="wikitext">
{{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>
</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'''
'''type'''
Line 125: Line 143:
:'''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 131: Line 149:
:'''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 141: Line 159:
: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 146: Line 167:


==== The small parameters ====
==== The small parameters ====
{{ombox
{{ombox
| small = yes
| small = yes
Line 162: Line 182:
{{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 191: Line 211:


=== Technical details ===
=== Technical details ===
If you need to use special characters in the text parameter then you need to escape them like this:  
If you need to use special characters in the text parameter then you need to escape them like this:  


<pre>
<syntaxhighlight lang="wikitext">
{{ombox
{{ombox
| text  = <div>
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are.  
Equal sign = and a start and end brace { } work fine as they are.  
But here is a pipe {{!}} and two end braces &lt;nowiki>}}&lt;/nowiki>.  
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>.  
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
</div>
}}
}}
</pre>
</syntaxhighlight>


{{ombox
{{ombox
Line 212: Line 231:
}}
}}


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


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 {{mw|Help:ParserFunctions|parser functions}} and special characters in parameters.  
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.


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.
===See also===
{{Mbox templates see also}}


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.
<templatedata>
{
"params": {
"text": {
"label": "Text of the box",
"description": "The text to be displayed inside the box; if you need to use special characters then use <nowiki>{{ombox}}</nowiki>.",
"example": "Hello, I am a box created using <nowiki>{{ombox}}</nowiki>.",
"type": "content",
"required": true
},
"type": {
"label": "Type of box to display",
"description": "The type of box that will be displayed (image, border thickness, colour, appearance). Examples from highest priority to lowest: \"speedy\", \"delete\", \"content\", \"style\", \"notice\", \"move\", and \"protection\".",
"example": "notice",
"type": "string",
"suggestedvalues": [
"speedy",
"delete",
"content",
"style",
"notice",
"move",
"protection"
],
"default": "notice",
"suggested": true
},
"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, with the size, typically 40–50px.",
"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. Without quotation marks \" \" but with the ending semicolons ;.",
"example": "text-align: center; style = margin-bottom: 0.5em;",
"type": "string"
},
"textstyle": {
"label": "CSS style for text",
"description": "Inline CSS styles, which will only be applied to the text itself. Without quotation marks \" \" but with the ending semicolons ;.",
"example": "text-align: center; text-color: red;",
"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, with the size, typically 40–50px.",
"example": "[[File:Some image.svg|40px]]",
"type": "content"
},
"plainlinks": {
"label": "Plain external links?",
"description": "Typically, external links have an arrow icon next to them, but in message boxes, this is suppressed by default. 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 a small right floating message box. This also makes the default images smaller.",
"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. If not set, “image” will be used anyway. Size 30px is about right. “none\" = Means that no image is used. This overrides any image fed to image, when \"small=yes\".",
"example": "[[File:Some image.svg|30px]], none"
},
"smallimageright": {
"label": "Small image to the right",
"description": "A small image to be used. Displays on the right. Only use this parameter if \"small\" is set. If not set, “image” will be used anyway. Size 30px is about right. “none\" = Means that no image is used. This overrides any image fed to imageright, when \"small=yes\".",
"example": "[[File:Some image.svg|30px]]",
"type": "content"
},
"smalltext": {
"label": "Shorter text",
"description": "A shorter version of the message body text. Will display if “small=yes\". Falls back to the \"text\" parameter if not used.",
"example": "Hi, I'm a summary!",
"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>


=== From ===
<includeonly>{{Sandbox other||
[http://en.wikipedia.org/wiki/Template:Ombox/doc Ombox/doc on Wikipedia]
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Mbox and messagebox templates]]


<includeonly>[[Category:Core wiki templates]]</includeonly>
}}</includeonly>
<noinclude>[[Category:Core wiki templates]]</noinclude>
Anonymous user
Retrieved from "https://saintapedia.org/wiki/Special:MobileDiff/13369"