Template:Ombox/doc
From FORwiki
(Difference between revisions)
(→Other pages message box types) |
|||
(4 intermediate revisions not shown) | |||
Line 1: | Line 1: | ||
- | + | It is used to build message box templates for pages. 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. | |
- | It is used to build message box templates for pages | + | |
This template works almost exactly like {{tl|ambox}} and uses the same parameters. | This template works almost exactly like {{tl|ambox}} and uses the same parameters. | ||
- | |||
- | |||
=== Usage === | === Usage === | ||
Line 90: | Line 87: | ||
| type = notice | | type = notice | ||
| image = [[Image:Blue check.svg|30px]] | | image = [[Image:Blue check.svg|30px]] | ||
- | | imageright = | + | | imageright = Guideline |
| text = | | text = | ||
- | '''This page documents an | + | '''This page documents an Foresight Wiki guideline.''' It is a generally accepted standard that editors should follow, though it should be treated with common sense and the occasional exception. |
}} | }} | ||
+ | |||
{{ombox | {{ombox | ||
| type = notice | | type = notice | ||
Line 136: | Line 134: | ||
'''style''' | '''style''' | ||
- | :Optional | + | :Optional 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> | ::<code>style = margin-bottom: 0.5em;</code> | ||
'''textstyle''' | '''textstyle''' | ||
- | :Optional | + | :Optional CSS values used by the text cell. For example: |
::<code>textstyle = text-align: center;</code> | ::<code>textstyle = text-align: center;</code> | ||
Current revision as of 01:30, 14 January 2010
It is used to build message box templates for pages. That is, 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.
Contents |
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. |
![]() |
type=style – Minor warnings and problems. |
![]() |
type=notice – Notices and messages of any kind, both permanent and temporary. |
![]() |
type=move – Merge, split, rename and transwiki messages and proposals. |
![]() |
type=protection – Protection templates 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 Foresight Wiki guideline. It is a generally accepted standard that editors should follow, though it should be treated with common sense and the occasional exception. | Guideline |
![]() |
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: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
![]() |
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.png|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.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.