Template:Event shop line/doc: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 04:01, 7 August 2022

This is a documentation subpage for Template:Event shop line.
It contains usage information, categories and other content that is not part of the original template page.

This template adds a row for each Event Shop item. It is advised to use the {{Event shop card}} or {{Event shop item}} templates for their autofill behavior.

{{Event shop head}}: Beginning of the Event Shop table
{{Event shop line}}: Generalized table row for an item in the Event Shop
- {{Event shop card}}: Specialized table row that automatically sets some fields
- {{Event shop item}}: Specialized table row that automatically sets some fields
{{Event shop tail}}: End of the Event Shop table.

Parameters[edit source]

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Thumbnail	`thumbnail`	The thumbnail of the item. For images, the recommended size is 75px. Example [[File:Jewel.png\|75px]]	String	required
Name	`name`	The name of the item. Example Crystal	String	required
Quantity	`quantity`	The quantity available for purchase. Example 5	Number	required
Cost	`cost`	The cost of the card, in event badges.	Number	required

Quick copy[edit source]

{{Event shop line|thumbnail= |name= |quantity= |cost= }}

Examples[edit source]

Thumbnail	Item	Quantity	Cost (badges)
	Crystal	5	100
	Magic cloth	500	10

@@ Line 1: / Line 1: @@
 {{documentation subpage}}
+This template adds a row for each Event Shop item. It is advised to use the {{t|Event shop card}} or {{t|Event shop item}} templates for their autofill behavior.
 * {{t|Event shop head}}: Beginning of the Event Shop table
 * {{t|Event shop line}}: Generalized table row for an item in the Event Shop
@@ Line 12: / Line 13: @@
 	"params": {
 		"thumbnail": {
-			"type": "wiki-file-name",
+			"type": "string",
-			"required": true
+			"required": true,
+			"label": "Thumbnail",
+			"description": "The thumbnail of the item. For images, the recommended size is 75px.",
+			"example": "[[File:Jewel.png|75px]]"
 		},
 		"name": {
 			"type": "string",
-			"required": true
+			"required": true,
+			"label": "Name",
+			"description": "The name of the item.",
+			"example": "Crystal"
 		},
 		"quantity": {
 			"type": "number",
-			"required": true
+			"required": true,
+			"label": "Quantity",
+			"description": "The quantity available for purchase.",
+			"example": "5"
 		},
 		"cost": {
 			"type": "number",
-			"required": true
+			"required": true,
+			"label": "Cost",
+			"description": "\t\n\nThe cost of the card, in event badges."
 		}
-	}
+	},
+	"format": "inline"
 }
 </templatedata>
+== Quick copy ==
+<pre>
+{{Event shop line|thumbnail= |name= |quantity= |cost= }}
+</pre>
+== Examples ==
+{{Event shop head}}
+{{Event shop line|thumbnail=[[File:Jewel.png|75px]]|name=Crystal|quantity=5|cost=100}}
+{{Event shop line|thumbnail=[[File:Magic cloth.png|75px]]|name=Magic cloth|quantity=500|cost=10}}
+{{Event shop tail}}
 <includeonly>[[Category:Event templates]]</includeonly>