Template:Performance/doc: Difference between revisions

Latest revision as of 23:33, 17 October 2024

Allows for the usage of performance icons.

will make:

Performance ranking icon

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Performance Ranking	`1`	What performance rank icon you want displayed Suggested values `excellent` `good` `medium` `poor` `verypoor` Default medium Example excellent	String	suggested
Icon size (in pixels)	`2`	Changes the size of the icon in pixels. Suggested values `16` `32` `64` `128` Default 32	Number	suggested

@@ Line 8: / Line 8: @@
 === Template parameters ===
-{| class="wikitable"
+<templatedata>
-|+ Caption text
+{
-|-
+	"params": {
-! Name !! Variable !! Description
+		"1": {
-|-
+			"label": "Performance Ranking",
-| Rank || <code>1</code>|| excellent|good|medium|poor|verypoor (defaults to medium)
+			"type": "string",
-|-
+			"suggestedvalues": [
-| Size || <code>2</code> || (Optional) size of the image file, default is 64px
+				"excellent",
-|}
+				"good",
+				"medium",
+				"poor",
+				"verypoor"
+			],
+			"default": "medium",
+			"suggested": true,
+			"description": "What performance rank icon you want displayed",
+			"example": "excellent"
+		},
+		"2": {
+			"label": "Icon size (in pixels)",
+			"description": "Changes the size of the icon in pixels.",
+			"type": "number",
+			"suggestedvalues": [
+				"16",
+				"32",
+				"64",
+				"128"
+			],
+			"default": "32",
+			"suggested": true
+		}
+	},
+	"paramOrder": [
+		"1",
+		"2"
+	],
+	"format": "inline",
+	"description": "Performance ranking icon"
+}
+</templatedata>
 <noinclude>[[Category:Template Documentation]]</noinclude>