Template:Background: Difference between revisions

Revision as of 05:32, 29 July 2024

Template documentation

This template is used to visually represent backgrounds.

Example	Markup	Renders as
Basic usage	{{Background\|Urchin}}	Urchin
Adjusted icon size	{{Background\|Acolyte\|w=40}}	Acolyte
Link alias	{{Background\|Charlatan\|Trickster}}	Trickster
Alias and adjusted size	{{Background\|Entertainer\|Musician\|w=20}}	Musician

Insert a link to a background accompanied by the associated icon.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Background name	`1`	The name of the background. Suggested values `Acolyte` `Charlatan` `Criminal` `Entertainer` `Folk Hero` `Guild Artisan` `Noble` `Outlander` `Sage` `Soldier` `Urchin` `Haunted One` `Hermit` `Sailor` `Trickster Hedonist` `Astral Zealot` `Wizard of Waterdeep` `Cloistered Stray` `Blade of Frontiers` `Blood War Veteran` `Underdark Exile` `Grove Tender` `World-Wise Heroine` `Legend of Baldur's Gate`	String	required
Alias	`2`	A user-defined alias to be shown instead of the background name.	String	optional
Icon size	`w`	The pixel size of the accompanying icon.	Number	optional

@@ Line 24: / Line 24: @@
 | Legend of Baldur's Gate
 | Hermit
-| Sailor = {{IconLink|Background {{{1}}} Icon.png|{{{1}}}|{{{alias|{{{1}}}}}}|size={{{2|25}}}|nowrap=y}}
+| Sailor = {{IconLink|Background {{{1}}} Icon.png|{{{1}}}|{{{2|{{{1}}}}}}|size={{{w|25}}}|nowrap=y}}
-| #default = [[{{{1}}}|{{{alias|{{{1}}}}}}]]
+| #default = [[{{{1}}}|{{{2|{{{1}}}}}}]]
 }}</includeonly><noinclude>
 {{documentation|content=
@@ Line 36: / Line 36: @@
 | <nowiki>{{Background|Urchin}}</nowiki>
 | caption 2 = Adjusted icon size
-| <nowiki>{{Background|Acolyte|40}}</nowiki>
+| <nowiki>{{Background|Acolyte|w=40}}</nowiki>
 | caption 3 = Link alias
-| <nowiki>{{Background|Charlatan|alias=Trickster}}</nowiki>
+| <nowiki>{{Background|Charlatan|Trickster}}</nowiki>
 | caption 4 = Alias and adjusted size
-| <nowiki>{{Background|Entertainer|20|alias=Musician}}</nowiki>
+| <nowiki>{{Background|Entertainer|Musician|w=20}}</nowiki>
 }}
@@ Line 81: / Line 81: @@
 			"required": true
 		},
-		"2": {
+        "2": {
+			"label": "Alias",
+			"description": "A user-defined alias to be shown instead of the background name.",
+			"type": "string"
+		},
+		"w": {
 			"label": "Icon size",
 			"description": "The pixel size of the accompanying icon.",
 			"type": "number"
-		},
-        "alias": {
-			"label": "Alias",
-			"description": "A user-defined alias to be shown instead of the background name.",
-			"type": "string"
 		}
 	}