User:Johan G/Messagebox: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
m (Oops, too early to categorise yet)
m (Oops again)
Line 1: Line 1:
<includeonly>{{#switch: {{nocat|}}
<includeonly>{{#switch: {{{nocat|}}}
| true =
| true =
| false = [[:Category:Templates using messagebox meta template]][[:Category:Messagebox templates]]
| false = [[:Category:Templates using messagebox meta template]][[:Category:Messagebox templates]]

Revision as of 18:59, 6 February 2014


The following template description is not displayed when the template is inserted in an article.

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-line    = 
| image       = 
| image-width = 

| page        = 
| nocat       = 
}}
title
Mandatory title for the messagebox that will be shown in bold, for example Danger, Warning, Caution, Cleanup, Note, Notice, Tip, Hint, Protected etc.
text
Mandatory text to be shown in the messagebox.

Parameters affecting the appearence

style
Optional style of the messagebox. Valid values are immediate, danger, caution, notice, tip and protected. Defaults to notice.
one-line
Optional parameter to make the dialogue a one-liner if one-line=true.
image
Optional image or icon to use excluding the File: namespace prefix, for example image=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
Optional width of the image. Defaults to 40 pixels or for one-liners 24 pixels.

Parameters for demonstration and testing

page
Wiki page to be used for demonstration and debugging purposes. 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