Template:Userbox/doc: Difference between revisions

Latest revision as of 01:33, 4 May 2026

Meta-template, used to create userbox templates

Template parameters
Parameter		Description	Type	Status
ID	`ID` `id` `icon`	Handful of characters / small image to go in the square on the left.	Unknown	required
Description	`description` `info`	Sentence-long description on the right	Unknown	required
ID color	`id-color` `icon-color` `square-color`	Hexcode for the color of the smaller rectangle on the left Default #fff	Unknown	optional
Background color	`background-color` `Info color` `info-color`	Hexcode for the background color Default #eee	Unknown	optional
Border color	`border-color` `border`	Hexcode for border color Default #aaa	Unknown	optional
Categories	`categories` `category`	Wikilinks for categories, to auto-populate when using template (don't put Category:Userboxes here!) Example [[Category:Class of 2026]]	Unknown	optional
ID text color	`id-text-color`	no description	Unknown	optional
Info text color	`info-text-color`	no description	Unknown	optional

Example

{{Userbox
| id       = '26
| info     = This user is in the class of 2026.
| border-color = #C2637A
| id-color     = #C2637A
}}

'26	This user is in the class of 2026.

@@ Line 4: / Line 4: @@
 	"params": {
 		"id-color": {
-			"description": "Hexcode"
+			"description": "Hexcode for the color of the smaller rectangle on the left",
+			"default": "#fff",
+			"aliases": [
+				"icon-color",
+				"square-color"
+			],
+			"label": "ID color"
 		},
-		"id": {
+		"border-color": {
-			"description": "Handful of characters"
+			"description": "Hexcode for border color",
+			"default": "#aaa",
+			"aliases": [
+				"border"
+			],
+			"label": "Border color"
 		},
-		"info-color": {
+		"categories": {
-			"description": "Hexcode"
+			"description": "Wikilinks for categories, to auto-populate when using template (don't put Category:Userboxes here!)",
+			"example": "[[Category:Class of 2026]]",
+			"aliases": [
+				"category"
+			],
+			"label": "Categories"
 		},
-		"info": {
+		"description": {
-			"description": "Sentence-long description"
+			"aliases": [
+				"info"
+			],
+			"label": "Description",
+			"description": "Sentence-long description on the right",
+			"required": true
+		},
+		"background-color": {
+			"aliases": [
+				"Info color",
+				"info-color"
+			],
+			"label": "Background color",
+			"description": "Hexcode for the background color",
+			"default": "#eee"
+		},
+		"ID": {
+			"aliases": [
+				"id",
+				"icon"
+			],
+			"label": "ID",
+			"description": "Handful of characters / small image to go in the square on the left.",
+			"required": true
+		},
+		"id-text-color": {
+			"label": "ID text color"
+		},
+		"info-text-color": {
+			"label": "Info text color"
 		}
 	},
 	"paramOrder": [
-		"id",
+		"ID",
-		"info",
+		"description",
 		"id-color",
-		"info-color"
+		"background-color",
-	]
+		"border-color",
+		"categories",
+		"id-text-color",
+		"info-text-color"
+	],
+	"description": "Meta-template, used to create userbox templates"
 }
 </templatedata>
@@ Line 33: / Line 83: @@
 | border-color = #C2637A
 | id-color     = #C2637A
-| info-color   = #fff
 }}
 </pre>
@@ Line 41: / Line 90: @@
 | border-color = #C2637A
 | id-color     = #C2637A
-| info-color   = #fff
 }}