Template:PageRef/doc: Difference between revisions
m name should be localized |
m alt_file_name added |
||
Line 64: | Line 64: | ||
"required": false, | "required": false, | ||
"example": "Death Slam" | "example": "Death Slam" | ||
}, | |||
"alt_file_name": { | |||
"label": "Alternate File Name", | |||
"description": "An optional way to designate which file to include. Not needed if <first parameter>.png is the same as the file name.", | |||
"type": "string", | |||
"required": false, | |||
"example": "Amber Hand.png" | |||
}, | }, | ||
"size": { | "size": { |
Revision as of 17:14, 28 November 2024
Overview
Outputs an icon in svg and a link to the given localized page with an optional alternate display name.
Output should be:
<icon> <pagename>
- Both icon and page name should be hyperlinked to first parameter as the pagename
- Icon should be
[[File:<pagename>.svg]]
if the svg file exists, otherwise the .png. - The .svg should be both light and dark theme compatible
- It's possible CSS may be used to automatically invert colors, precluding the need for the icon to be theme-compatible
- The .png should be default theme compatible (light)
Examples
Jacob Bullet Lifesteal Siphon Life
not yet working
Below is a fake example. Ideally, the template is called like:
{{PageRef|Lash|alt_name=Jacob}}
In wikitext it would look be outputted as:
[[File:Lash.svg|class=dark_or_light|link=Lash|size=15]] [[Lash|Jacob]]
Which would appear in visual as
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | The localized name of the page to link to, also used to determine the icon.
| String | required |
Alternate Name | alt_name | An optional display name to show instead of the page name in the link.
| String | optional |
Alternate Link | alt_link | An optional link to link to instead of the 1st parameter (name).
| String | optional |
Alternate File Name | alt_file_name | An optional way to designate which file to include. Not needed if <first parameter>.png is the same as the file name.
| String | optional |
Size | size | Size of the icon link, defaulted to '15'px
| Number | optional |