Template:MessageBox/doc: Difference between revisions

(3 intermediate revisions by 2 users not shown)

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

:~~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...

:<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...

{{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~~}}]]</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]]</includeonly>

<noinclude>[[Category:Template documentation]]</noinclude>

@@ 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
-: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...
 {{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>
 ::gives...
 {{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>