Template:PageRef/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
m alt_link example
Sur (talk | contribs)
m name should be localized
 
Line 1: Line 1:
=Overview=
=Overview=
Outputs an icon in svg and a link to the given page with an optional alternate display name.
Outputs an icon in svg and a link to the given localized page with an optional alternate display name.


Output should be:<br>
Output should be:<br>
Line 46: Line 46:
         "name": {
         "name": {
             "label": "Name",
             "label": "Name",
             "description": "The name of the page to link to, also used to determine the icon.",
             "description": "The localized name of the page to link to, also used to determine the icon.",
             "type": "string",
             "type": "string",
             "required": true,
             "required": true,

Latest revision as of 19:57, 20 October 2024

Overview[edit source]

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[edit source]

Jacob Bullet Lifesteal Siphon Life

not yet working[edit source]

Jacob

50 Siphon Life

AttributeIconTechDuration

Basic Magazine

100 Shop


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
Sizesize

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

Example
50
Numberoptional