Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:MessageBox/doc: Difference between revisions

Template page
Fix parameter name
Add TemplateData.
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
;Description
; Description
:This template is used to do include various messages in text. Escalation messages, pop-up messages from Combat complexes, messages in local chat channel.
: This template is used to do include various messages, in a collapsible box in text. Escalation messages, pop-up messages from Combat complexes, messages in local chat channel etc.
 
;Syntax
;Syntax
:Type <code>{{t|MessageBox|head|text|4=collapsed=yes}}</code> somewhere.
: {{T|MessageBox|head|text|4= collapsed= yes}}
:The <code>collapsible</code> parameter is optional. To make the message box collapsible, use <code>collapsible=yes</code>; otherwise, omit it.  
:; Parameters
;Sample output
::; head : Text in the header of the message box
:<code><nowiki>{{MessageBox|In local chat channel:|Serpentis Mug: Blah.}}</nowiki></code>
::; text : Text in the body of the box
::; collapsed= : Controls whether the box is initially collapsed. use <code>collapsed= yes</code> to have the box initially collapsed, otherwise omit it.
 
; Sample
: <code><nowiki>{{MessageBox|In local chat channel:|Serpentis Mug: Blah.}}</nowiki></code>
::gives...
::gives...
{{MessageBox|In local chat channel:|Serpentis Mug: Blah.}}
{{MessageBox|In local chat channel:|Serpentis Mug: Blah.}}
:<code><nowiki>{{MessageBox|In local chat channel:|Serpentis Lion: And who are you, the proud lord said, that I must bow so low?|collapsed=yes}}</nowiki></code>
:<code><nowiki>{{MessageBox|In local chat channel:|Serpentis Lion: And who are you, the proud lord said, that I must bow so low?|collapsed=yes}}</nowiki></code>
::gives...
::gives...
{{MessageBox|In local chat channel:|Serpentis Lion: And who are you, the proud lord said, that I must bow so low?|collapsed=yes}}
{{MessageBox|In local chat channel:|Serpentis Lion: And who are you, the proud lord said, that I must bow so low?|collapsed=yes}}


<includeonly>[[Category:Template|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
 
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
; Template data
: This is the [[mediawikiwiki:Help:TemplateData|TemplateData]] documentation for this template used by [[mediawikiwiki:VisualEditor|VisualEditor]] and other tools.
:: <templatedata>
{
"params": {
"1": {
"label": "Message title",
"type": "string",
"suggested": true
},
"2": {
"label": "Message text",
"required": true
},
"collapsed": {
"label": "Initially collapsed?",
"type": "string",
"suggestedvalues": [
"yes"
],
"description": "Leave empty when box should be initially expanded."
}
},
"description": "Box (collapsible) to show in-game messages etc.",
"format": "block"
}</templatedata>
 
 
<includeonly>[[Category:Formatting templates]]<!-- Any categories for the template itself --></includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 18:11, 25 June 2025

Description
This template is used to do include various messages, in a collapsible box in text. Escalation messages, pop-up messages from Combat complexes, messages in local chat channel etc.
Syntax
{{MessageBox|<head>|<text>|<collapsed= yes>}}
Parameters
head
Text in the header of the message box
text
Text in the body of the box
collapsed=
Controls whether the box is initially collapsed. use collapsed= yes to have the box initially collapsed, otherwise omit it.
Sample
{{MessageBox|In local chat channel:|Serpentis Mug: Blah.}}
gives...
In local chat channel:
Serpentis Mug: Blah.
{{MessageBox|In local chat channel:|Serpentis Lion: And who are you, the proud lord said, that I must bow so low?|collapsed=yes}}
gives...
In local chat channel:
Serpentis Lion: And who are you, the proud lord said, that I must bow so low?


Template data
This is the TemplateData documentation for this template used by VisualEditor and other tools.

Box (collapsible) to show in-game messages etc.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Message title1

no description

Stringsuggested
Message text2

no description

Unknownrequired
Initially collapsed?collapsed

Leave empty when box should be initially expanded.

Suggested values
yes
Stringoptional