Template:PageRef/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
m name should be localized
Sur (talk | contribs)
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

Jacob

50Siphon Life

AttributeIconTechDuration

Basic Magazine

100Shop


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

Jacob

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The localized name of the page to link to, also used to determine the icon.

Example
Lash
Stringrequired
Alternate Namealt_name

An optional display name to show instead of the page name in the link.

Example
Jacob
Stringoptional
Alternate Linkalt_link

An optional link to link to instead of the 1st parameter (name).

Example
Death Slam
Stringoptional
Alternate File Namealt_file_name

An optional way to designate which file to include. Not needed if <first parameter>.png is the same as the file name.

Example
Amber Hand.png
Stringoptional
Sizesize

Size of the icon link, defaulted to '15'px

Example
50
Numberoptional