User:Johan G/Messagebox
box format and style valid
|
top;note;top;messagebox/icon: no image;multiliner text padding;; |
Goal
This template is a meta template for messagebox templates of various kinds.
Adding this template to a page in the template namespace will automatically add Category:Messagebox templates and the hidden Category:Templates using messagebox meta template to that page.
Usage
{{messagebox
| title =
| text =
| style =
| one-liner =
| image =
| image-width =
| box =
| box-style =
| image-style =
| text-style =
| page =
| nocat =
}}
Main parameters
- title
- Optional alternative title for the messagebox that will be shown in bold, for example Danger, Warning, Caution, Cleanup, Note, Notice, Tip, Hint, Protected, Nominated for deletion etc. Defaults to Notice.
- text
- Text to be shown in the messagebox.
Parameters affecting the appearance
Optional parameters affecting the appearance of the messagebox.
- style
- Style of the messagebox. Valid values are speedy, warning, caution, note, tip, protected and neutral. Defaults to notice.
- one-liner
- Makes the messagebox a one-liner if not empty.
- image
- Image or icon to use excluding the File: namespace prefix, for example Cleanup.png. Instead of an image name a shortcut can be used. When using the shortcuts the icons will automatically get the right colour for the style. Valid icon shortcuts are: /!\, (!), (?), (i), (x) and U (for padlock).
- image-width
- Width of the image in pixels. Defaults to 40 pixels or for one-liners 24 pixels.
- box
- Will override the box format. Valid values are box, top and section. The defaults are box for the talk namespaces and the category namespace, and top for any other namespace.
CSS Style parameters
Optional parameters allowing cascading style sheet (CSS) style attributes to be used. These will override the style of the messagebox. Use sparingly and only when needed.
- box-style
- CSS attributes applied to the box.
- text-style
- CSS attributes applied to the text cell.
- image-style
- CSS attributes applied to the image cell.
Parameters for demonstration and testing
Optional parameters for demonstration and testing.
- page
- Wiki page. Use
page = {{{page|}}}to forward this behaviour to a template.
- nocat
- If nocat=true pages are not categorized, if nocat=false pages are always categorized, and if nocat is empty or undefined only pages in the template namespace are categorised.
- Do not forward this parameter to a template for category suppression, instead use the techniques discussed in Category suppression below.
Category suppression
In cases where a template using {{messagebox}} is automatically categorising pages it is highly recommended to use {{messagebox}} together with a namespace template to suppress categorisation if a template is used on other pages than the intended ones, like for example in lists of templates. Some common namespace templates are for example {{category handler}}, {{main other}}, {{talk other}} and {{category other}}.
Where one of the "other" templates are sufficient, a way to add a nocat parameter working in a similar way as in {{category handler}} to a template is to do as in the below example:
...{{#switch: {{[nocat|}}}
| true = <!-- Will not categorise a page -->
| false = [[Category:Some category]] <!-- Will always categorise a page -->
| #default = {{main other | [[Category:Same category]] }} <!-- Will categorise a page only if it is in the main namespace, the article namespace. -->
}}...
Examples
Examples using different options.
Related templates