Template:Stat/doc: Difference between revisions

Latest revision as of 11:23, 26 March 2026

A helper template that generates a row for the Statistics widget on the main page.

Template parameters
Parameter		Description	Type	Status
Measurement	`1`	no description Default Shelter	String	optional
Value	`2`	no description Default 100%	String	optional
Target page	`target`	Name of a linked page.	Page name	optional
Image	`image`	Name of the image for the icon. Default Shelter.png	String	optional
CSS class	`class`	A valid CSS class name to add to the row.	String	optional

{{stat|Guardians:|14|image=Icon-Guardians.png}}

Guardians:

14

The widget is designed for manual updating: MediaWiki:Shelter-statistics.

@@ Line 1: / Line 1: @@
-	local itemName = args[1] or 'Shelter'
-	local itemValue = args[2] or '100%'
-	local itemTarget = args['target'] or nil
-	local itemClass = args['class'] or ''
-	local itemImage = args['image'] or 'Shelter.png'
-{{Stat}}
 <templatedata>
 {
@@ Line 11: / Line 4: @@
 		"1": {
 			"label": "Measurement",
-			"type": "string"
+			"type": "string",
+			"default": "Shelter"
 		},
 		"2": {
 			"label": "Value",
-			"type": "string"
+			"type": "string",
+			"default": "100%"
 		},
 		"target": {
@@ Line 25: / Line 20: @@
 			"label": "Image",
 			"description": "Name of the image for the icon.",
+			"type": "string",
+			"default": "Shelter.png"
+		},
+		"class": {
+			"label": "CSS class",
+			"description": "A valid CSS class name to add to the row.",
 			"type": "string"
 		}
@@ Line 31: / Line 32: @@
 }
 </templatedata>
+== Example ==
+<pre>
+{{stat|Guardians:|14|image=Icon-Guardians.png}}
+</pre>
+;Result
+{{stat|Guardians:|14|image=Icon-Guardians.png}}
+The widget is designed for manual updating: [[MediaWiki:Shelter-statistics]].