Template:Background: Difference between revisions

Revision as of 23:09, 26 January 2024

Template documentation

This template is used to visually represent Backgrounds.

Usage: {{Background|Urchin}}

Result: Urchin

Usage: {{Background|Acolyte|40}}

Result: Acolyte

Usage: {{Background|Charlatan|alias=Trickster}}

Usage: {{Background|Entertainer|20|alias=Musician}}

No description.

Template parameters
Parameter		Description	Type	Status
Background name	`1`	The name of the Background.	String	required
Icon size	`2`	The pixel size of the accompanying icon.	Number	optional
Alias	`3`	A user-defined alias to be shown instead of the Background name.	String	optional

@@ Line 1: / Line 1: @@
 <includeonly>{{BackgroundIcon|{{{1}}}|{{{2|25}}}}} [[{{{1}}}|{{{alias|{{{1}}}}}}]]</includeonly><noinclude>
-Usage: {{code|<nowiki>{{Background|Urchin}}</nowiki>}}
+{{documentation|content=
+This template is used to visually represent Backgrounds.
+Usage: <code><nowiki>{{Background|Urchin}}</nowiki></code>
 Result: {{Background|Urchin}}
-or Result: {{Background|Urchin|40}} {{code|<nowiki>{{Background|Urchin|40}}</nowiki>}}
+Usage: <code><nowiki>{{Background|Acolyte|40}}</nowiki></code>
+Result: {{Background|Acolyte|40}}
+Usage: <code><nowiki>{{Background|Charlatan|alias=Trickster}}</nowiki></code>
-With Alias: {{code|<nowiki>{{Background|Urchins|alias=Urchin}}</nowiki>}}
+Result: {{Background|Charlatan|alias=Trickster}}
-Result: {{Background|Urchin|alias=Urchins}}
+Usage: <code><nowiki>{{Background|Entertainer|20|alias=Musician}}</nowiki></code>
+Result: {{Background|Entertainer|20|alias=Musician}}
 [[Category:Templates]]
-</noinclude>
+== Template data==
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Background name",
+			"description": "The name of the Background.",
+			"type": "string",
+			"required": true
+		},
+		"2": {
+			"label": "Icon size",
+			"description": "The pixel size of the accompanying icon.",
+			"type": "number"
+		},
+        "3": {
+			"label": "Alias",
+			"description": "A user-defined alias to be shown instead of the Background name.",
+			"type": "string"
+		}
+	}
+}
+</templatedata>}}</noinclude>