Template:PageRef/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
m alt_file_name added
Sur (talk | contribs)
m old guide info removed; docs now much more readable; all new examples written including for new param alt_file_name
Line 2: Line 2:
Outputs an icon in svg and a link to the given localized 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 will be:<br>
<icon> <pagename>
<icon> <pagename>


* Both icon and page name should be hyperlinked to first parameter as the pagename
* Both icon and page name will be hyperlinked to first parameter as the pagename
* Icon should be <pre style="width: fit-content>[[File:<pagename>.svg]]</pre> if the svg file exists, otherwise the .png.  
* Icon should be <pre style="width: fit-content>[[File:<pagename>.svg]]</pre> if the svg file exists, otherwise the .png.  
* The .svg should be both light and dark theme compatible
** The .svg should be both light and dark theme compatible (WIP)
** It's possible CSS may be used to automatically invert colors, precluding the need for the icon to be 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)
** The .png should at least be default theme compatible (light)
** If neither the .svg nor the .png exist, the icon will not be added
* If the first parameter (name) is a hero name in english, it will automatically use the <hero>_MM.png file
** Otherwise, if the file name is different to the page name (do not use this in excess), the <i>alt_file_name</i> parameter will need to be used
 


=Examples=
=Examples=
In its simplest form: <code><nowiki>{{PageRef|Lash}}</nowiki></code> {{PageRef|Lash}}


{{PageRef|Lash|alt_name=Jacob}}
Using alt_name: <code><nowiki>{{PageRef|Lash|alt_name=Jacob}}</nowiki></code> {{PageRef|Lash|alt_name=Jacob}}
{{PageRef|Bullet Lifesteal|alt_link=Bullet Lifesteal (item)}}
{{PageRef|Siphon Life|alt_link=Abrams#(1) Siphon Life}}
 
==not yet working==
 
{{PageRef|Lash|alt_name=Jacob}}
 
{{PageRef|Siphon Life|size=50}}
 
{{PageRef|AttributeIconTechDuration}}
 
{{PageRef|Basic Magazine}}
 
{{PageRef|The Curiosity Shop|alt_name=Shop|size=100}}
 


Below is a fake example. Ideally, the template is called like:
Using alt_link (hover the link to see): <code><nowiki>{{PageRef|Lash|alt_link=Cold Front}}</nowiki></code> {{PageRef|Lash|alt_link=Cold Front}}


<pre style="width: fit-content">{{PageRef|Lash|alt_name=Jacob}}</pre>
Using alt_file_name: <code><nowiki>{{PageRef|Lash|alt_file_name=Cold Front}}</nowiki></code> {{PageRef|Lash|alt_file_name=Cold Front}}


In wikitext it would look be outputted as:
Using them all together, note that the first parameter is no longer used and therefore not needed:  
<pre style="width: fit-content">[[File:Lash.svg|class=dark_or_light|link=Lash|size=15]] [[Lash|Jacob]]</pre>
<code><nowiki>{{PageRef|alt_name=Cold Front|alt_link=Cold Front|alt_file_name=Cold Front}}</nowiki></code>
{{PageRef|alt_name=Cold Front|alt_link=Cold Front|alt_file_name=Cold Front}}


Which would appear in visual as
Note: Instead of repeated use of <i>alt_file_name</i>, it is recommended to create a redirect at <nowiki>[[<first_parameter>.png]]</nowiki> to <nowiki>[[<alt_file_name>.png]]</nowiki>, allowing the use of the simplest form of PageRef, making it much easier to reference in the future.


{{HeroIcon|Lash|Jacob}}
=Parameters=


<templatedata>
<templatedata>
Line 67: Line 58:
         "alt_file_name": {
         "alt_file_name": {
             "label": "Alternate 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.",
             "description": "An optional way to designate which file to include. Not needed if <first parameter> (name) is the same as the file name. File extension not needed, as it will try to prioritize the .svg first, otherwise use the .png.",
             "type": "string",
             "type": "string",
             "required": false,
             "required": false,

Revision as of 17:39, 28 November 2024

Overview

Outputs an icon in svg and a link to the given localized page with an optional alternate display name.

Output will be:
<icon> <pagename>

  • Both icon and page name will 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 (WIP)
      • It's possible CSS may be used to automatically invert colors, precluding the need for the icon to be theme-compatible
    • The .png should at least be default theme compatible (light)
    • If neither the .svg nor the .png exist, the icon will not be added
  • If the first parameter (name) is a hero name in english, it will automatically use the <hero>_MM.png file
    • Otherwise, if the file name is different to the page name (do not use this in excess), the alt_file_name parameter will need to be used


Examples

In its simplest form: {{PageRef|Lash}} Lash

Using alt_name: {{PageRef|Lash|alt_name=Jacob}} Jacob

Using alt_link (hover the link to see): {{PageRef|Lash|alt_link=Cold Front}} Lash

Using alt_file_name: {{PageRef|Lash|alt_file_name=Cold Front}} Lash

Using them all together, note that the first parameter is no longer used and therefore not needed: {{PageRef|alt_name=Cold Front|alt_link=Cold Front|alt_file_name=Cold Front}} Cold Front

Note: Instead of repeated use of alt_file_name, it is recommended to create a redirect at [[<first_parameter>.png]] to [[<alt_file_name>.png]], allowing the use of the simplest form of PageRef, making it much easier to reference in the future.

Parameters

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> (name) is the same as the file name. File extension not needed, as it will try to prioritize the .svg first, otherwise use the .png.

Example
Amber Hand.png
Stringoptional
Sizesize

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

Example
50
Numberoptional