Template:Background: Difference between revisions
Jump to navigation
Jump to search
HiddenDragon (talk | contribs) (Updated to use iconlink and supplies icons only for actual backgrounds) |
m (Updated documentation with Template demo) |
||
| Line 28: | Line 28: | ||
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
{{documentation|content= | {{documentation|content= | ||
This template is used to visually represent backgrounds. | |||
== Examples == | |||
{{Template demo | |||
| style = table | |||
| caption 1 = Basic usage | |||
| <nowiki>{{Background|Urchin}}</nowiki> | |||
| caption 2 = Adjusted icon size | |||
| <nowiki>{{Background|Acolyte|40}}</nowiki> | |||
| caption 3 = Link alias | |||
| <nowiki>{{Background|Charlatan|alias=Trickster}}</nowiki> | |||
| caption 4 = Alias and adjusted size | |||
| <nowiki>{{Background|Entertainer|20|alias=Musician}}</nowiki> | |||
}} | |||
== Template data== | == Template data== | ||
<templatedata> | <templatedata> | ||
{ | { | ||
"description": "Insert a link to a background accompanied by the associated icon.", | |||
"format": "inline", | |||
"params": { | "params": { | ||
"1": { | "1": { | ||
"label": "Background name", | "label": "Background name", | ||
"description": "The name of the | "description": "The name of the background.", | ||
"type": "string", | "type": "string", | ||
"suggestedvalues": [ | |||
"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" | |||
], | |||
"required": true | "required": true | ||
}, | }, | ||
| Line 65: | Line 88: | ||
"alias": { | "alias": { | ||
"label": "Alias", | "label": "Alias", | ||
"description": "A user-defined alias to be shown instead of the | "description": "A user-defined alias to be shown instead of the background name.", | ||
"type": "string" | "type": "string" | ||
} | } | ||
} | } | ||
} | } | ||
</templatedata>}}</noinclude> | </templatedata>}} | ||
[[Category:Templates]] | |||
[[Category:Link templates]] | |||
</noinclude> | |||
Revision as of 05:25, 29 July 2024
Template documentation
This template is used to visually represent backgrounds.
Examples
| Example | Markup | Renders as |
|---|---|---|
| Basic usage | {{Background|Urchin}} |  |
| Adjusted icon size | {{Background|Acolyte|40}} |  |
| Link alias | {{Background|Charlatan|alias=Trickster}} |  |
| Alias and adjusted size | {{Background|Entertainer|20|alias=Musician}} |  |
Template data
Insert a link to a background accompanied by the associated icon.
| 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 | alias | A user-defined alias to be shown instead of the background name. | String | optional |