Template:Messagebox/doc: Difference between revisions

remove CSS example
Add Template Data
 
(2 intermediate revisions by the same user not shown)
Line 26: Line 26:


== Visual Examples ==
== Visual Examples ==
<pre>
{{Messagebox
{{Messagebox
| text = no type, uses default (normal)
| text = no type, uses default (normal)
| style = width:50%;
| style = width:50%;
}}
}}
</pre>
{{Messagebox
| text = no type, uses default (normal)
| style = width:50%;
}}


<pre>
{{Messagebox
| type = normal
| text = Why be normal?
}}
</pre>
{{Messagebox
{{Messagebox
| type = normal
| type = normal
Line 36: Line 49:
}}
}}


<pre>
{{Messagebox
| type = success
| text = You won!
}}
</pre>
{{Messagebox
{{Messagebox
| type = success
| type = success
Line 41: Line 60:
}}
}}


<pre>
{{Messagebox
| type = warning
| text = Do not spit into the wind
}}
</pre>
{{Messagebox
{{Messagebox
| type = warning
| type = warning
Line 46: Line 71:
}}
}}


<pre>
{{Messagebox
{{Messagebox
|type = failure
|type = failure
|text = You kissed your cousin
|text = Something went wrong.
}}
</pre>
{{Messagebox
|type = failure
|text = Something went wrong.
}}
 
<pre>
{{Messagebox
| type = forbidden
| text = You can't do that!
}}
}}


</pre>
{{Messagebox
{{Messagebox
| type = forbidden
| type = forbidden
Line 56: Line 94:
}}
}}


<pre>
{{Messagebox
| type = restricted
| text = You must be a registered user to create or edit articles.  Contact the [[User:Freephile|WikiSysop]] for an account!
}}
</pre>
{{Messagebox
{{Messagebox
| type = restricted
| type = restricted
Line 62: Line 106:


== Making this template ==
== Making this template ==
To generate the resized images from svg
[[Image:Dialog-error.svg|20px]]
[[Image:Dialog-warning.svg|20px]]
[[Image:Dialog-ok-apply.svg|20px]]
[[Image:Dialog-information.svg|20px]]
[[Image:Dialog-cancel.svg|20px]]
[[Image:Dialog-password.svg|20px]]


The parser code (how to do switch statements) is based on the example of the Ambox template from Mediawiki
The parser code (how to do switch statements) is based on the example of the Ambox template from Mediawiki
Line 75: Line 112:


[[Category:Templates using ParserFunctions]]
[[Category:Templates using ParserFunctions]]
<templatedata>
{
"params": {
"type": {
"label": "Type of box",
"description": "Type determines the decoration of the message box",
"type": "string",
"suggestedvalues": [
"success",
"warning",
"failure",
" restricted",
"forbidden",
"normal"
],
"default": "normal"
},
"style": {
"label": "CSS markup",
"description": "Add CSS if desired. This will be passed to the \"style\" attribute of the containing div.",
"example": "width:50%;",
"type": "string"
},
"text": {
"label": "Your message",
"description": "The text (and wiki markup) displayed in the message box.",
"type": "string",
"required": true
}
},
"description": "Messagebox is for creating call-outs of text in a bordered box. This visually distinguishes the text from other content on the page. There are multiple \"types\" that are predefined - basically red, yellow green.",
"format": "block"
}
</templatedata>