Template:Race: Difference between revisions
Jump to navigation
Jump to search
HiddenDragon (talk | contribs) (Replace alias parameter with standard alias syntax) |
m (Updated documentation) |
||
Line 42: | Line 42: | ||
| White Dragonborn = {{IconLink|Race {{{1}}}.png|{{{1}}}|{{{2|{{{1}}}}}}|size={{{w|25}}}|nowrap=y}} | | White Dragonborn = {{IconLink|Race {{{1}}}.png|{{{1}}}|{{{2|{{{1}}}}}}|size={{{w|25}}}|nowrap=y}} | ||
| #default = [[{{{1}}}|{{{2|{{{1}}}}}}]] | | #default = [[{{{1}}}|{{{2|{{{1}}}}}}]] | ||
}}</includeonly><noinclude>{{documentation|content= | }}</includeonly><noinclude>{{documentation|content= | ||
Insert a link to one of the [[Races|playable races]] accompanied by the associated icon. | |||
Usage | == Usage == | ||
This is intended mainly for lists, not in-line in body content as per the [[Help:Style manual|Style Manual]]. The race name is case sensitive and needs to exactly match (e.g. Half-Elf, not Half Elf). | |||
{{ | == Examples == | ||
{{Template demo | |||
| style = table | |||
| caption 1 = Basic usage | |||
| <nowiki>{{Race|Duergar}}</nowiki> | |||
| caption 2 = Adjusted icon size | |||
| <nowiki>{{Race|Half-Orc|w=35}}</nowiki> | |||
| caption 3 = Link alias | |||
| <nowiki>{{Race|Half-Elf|Half-Elves}}</nowiki> | |||
}} | |||
== See also == | |||
* {{t link|Background}} - An equivalent template for [[backgrounds]] | |||
* {{t link|Class}} - An equivalent template for [[classes]] | |||
{{ | * {{t link|Skill}} - An equivalent template for [[skills]] | ||
== Template data== | |||
<templatedata> | |||
{ | |||
"description": "Insert a link to a race accompanied by the associated icon. For use in lists and similar contexts only. This should not be used inline in the body of a paragraph as per the style manual. In those cases, use a normal link instead.", | |||
"format": "inline", | |||
"params": { | |||
"1": { | |||
"label": "Race name", | |||
"description": "The name of the race. This is case sensitive.", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Human", | |||
"Githyanki", | |||
"Half-Orc", | |||
"Dwarf", | |||
"Elf", | |||
"Drow", | |||
"Tiefling", | |||
"Halfling", | |||
"Half-Elf", | |||
"Gnome", | |||
"Dragonborn", | |||
"Hill Dwarf", | |||
"Gold Dwarf", | |||
"Mountain Dwarf", | |||
"Shield Dwarf", | |||
"Duergar", | |||
"High Elf", | |||
"Wood Elf", | |||
"Seldarine Drow", | |||
"Lolth-Sworn Drow", | |||
"Asmodeus Tiefling", | |||
"Mephistopheles Tiefling", | |||
"Zariel Tiefling", | |||
"Lightfoot Halfling", | |||
"Strongheart Halfling", | |||
"Wood Half-Elf", | |||
"High Half-Elf", | |||
"Drow Half-Elf", | |||
"Rock Gnome", | |||
"Deep Gnome", | |||
"Forest Gnome", | |||
"Black Dragonborn", | |||
"Blue Dragonborn", | |||
"Brass Dragonborn", | |||
"Bronze Dragonborn", | |||
"Copper Dragonborn", | |||
"Gold Dragonborn", | |||
"Green Dragonborn", | |||
"Red Dragonborn", | |||
"Silver Dragonborn", | |||
"White Dragonborn" | |||
], | |||
"required": true | |||
}, | |||
"2": { | |||
"label": "Alias", | |||
"description": "A user-defined alias to be shown instead of the race name.", | |||
"type": "string" | |||
}, | |||
"w": { | |||
"label": "Icon size", | |||
"description": "The pixel size of the accompanying icon.", | |||
"type": "number" | |||
} | |||
} | |||
} | |||
</templatedata>}} | |||
[[Category:Templates]] | [[Category:Templates]] | ||
[[Category:Link templates]] | |||
</noinclude> |
Revision as of 15:02, 29 July 2024
Template documentation
Insert a link to one of the playable races accompanied by the associated icon.
Usage
This is intended mainly for lists, not in-line in body content as per the Style Manual. The race name is case sensitive and needs to exactly match (e.g. Half-Elf, not Half Elf).
Examples
Example | Markup | Renders as |
---|---|---|
Basic usage | {{Race|Duergar}} | |
Adjusted icon size | {{Race|Half-Orc|w=35}} | |
Link alias | {{Race|Half-Elf|Half-Elves}} |
See also
- {{Background}} - An equivalent template for backgrounds
- {{Class}} - An equivalent template for classes
- {{Skill}} - An equivalent template for skills
Template data
Insert a link to a race accompanied by the associated icon. For use in lists and similar contexts only. This should not be used inline in the body of a paragraph as per the style manual. In those cases, use a normal link instead.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Race name | 1 | The name of the race. This is case sensitive.
| String | required |
Alias | 2 | A user-defined alias to be shown instead of the race name. | String | optional |
Icon size | w | The pixel size of the accompanying icon. | Number | optional |