Template:Background: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(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.


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>
}}


Usage: <code><nowiki>{{Background|Urchin}}</nowiki></code>
Result: {{Background|Urchin}}
Usage: <code><nowiki>{{Background|Acolyte|40}}</nowiki></code>
Result: {{Background|Acolyte|40}}
Usage: <code><nowiki>{{Background|Charlatan|alias=Trickster}}</nowiki></code>
Result: {{Background|Charlatan|alias=Trickster}}
Usage: <code><nowiki>{{Background|Entertainer|20|alias=Musician}}</nowiki></code>
Result: {{Background|Entertainer|20|alias=Musician}}
[[Category:Templates]]
== 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 Background.",
"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 Background name.",
"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 06:25, 29 July 2024

Template documentation

This template is used to visually represent backgrounds.

Examples

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

Template data

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Background name1

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
Stringrequired
Icon size2

The pixel size of the accompanying icon.

Numberoptional
Aliasalias

A user-defined alias to be shown instead of the background name.

Stringoptional