Editing Template:PageRef/doc

Jump to navigation Jump to search
Warning: You are not logged in. Once you make an edit, a temporary account will be created for you. Learn more. Log in or create an account to continue receiving notifications after this account expires, and to access other features.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
Note: It's recommended to use {{tl|HeroIcon}}, {{tl|AbilityIcon}}, or {{tl|ItemIcon}} instead, as those templates use [[Module:Icon]] and thus allow for more elaborate functions such as custom previews. PageRef should only be used for icons not covered in those templates, i.e. {{PageRef|Hidden King}} or {{PageRef|Shopkeeper}}.
=Overview=
=Overview=
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.
Line 10: Line 9:
** The .svg should be both light and dark theme compatible (WIP)
** 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 at least be default theme compatible (dark)
** 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 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
* 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
** 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


The code for this template is at [[Module:PageRef]]. The module also lists exceptions for pages that currently do not have an icon uploaded, so that templates such as [[Template:VoiceLineCite]] do not use a broken image link. If an icon for those pages is added, they should be removed from the exceptions list.


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


Example where the icon doesn't exist: <code><nowiki>{{PageRef|Shopkeeper}}</nowiki></code> {{PageRef|Shopkeeper}}
Example where the icon doesn't exist: <code><nowiki>{{PageRef|Amber Hand}}</nowiki></code> {{PageRef|Amber Hand}}


Using alt_name: <code><nowiki>{{PageRef|Lash|alt_name=Jacob}}</nowiki></code> {{PageRef|Lash|alt_name=Jacob}}
Using alt_name: <code><nowiki>{{PageRef|Lash|alt_name=Jacob}}</nowiki></code> {{PageRef|Lash|alt_name=Jacob}}
Line 34: Line 32:
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.
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.


If a file does not exist, it will look like
=Parameters=
{{PageRef|My cool page}}
 
To not use the file, use:
<code><nowiki>{{PageRef|My cool page|no_file=true}}</nowiki></code>
{{PageRef|My cool page|no_file=true}}
 
Using lang with to override language (e.g., Russian):
<code><nowiki>{{PageRef|Lash|lang=/ru}}</nowiki></code>
{{PageRef|Lash|lang=/ru}}


=Parameters=
<templatedata>
<templatedata>
{
{
"params": {
    "params": {
"name": {
        "name": {
"label": "Name",
            "label": "Name",
"description": "The localized 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.",
"required": true,
            "type": "string",
"example": "Lash",
            "required": true,
"aliases": [
            "example": "Lash"
"1"
        },
],
        "alt_name": {
"type": "string"
            "label": "Alternate Name",
},
            "description": "An optional display name to show instead of the page name in the link.",
"no_file": {
            "type": "string",
"label": "Do not use file",
            "required": false,
"description": "Do not use any file; also use this parameter when a file doesn't exist. Note that passing 'false' does not make it use a file, the parameter must then be omitted. This is for code efficiency",
            "example": "Jacob"
"required": false,
        },
"example": "true",
        "alt_link": {
"type": "string"
            "label": "Alternate Link",
},
            "description": "An optional link to link to instead of the 1st parameter (name).",
"alt_name": {
            "type": "string",
"label": "Alternate Name",
            "required": false,
"description": "An optional display name to show instead of the page name in the link.",
            "example": "Death Slam"
"type": "string",
        },
"required": false,
        "alt_file_name": {
"example": "Jacob"
            "label": "Alternate 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.",
"alt_link": {
            "type": "string",
"label": "Alternate Link",
            "required": false,
"description": "An optional link to link to instead of the 1st parameter (name).",
            "example": "Amber Hand.png"
"type": "string",
        },
"required": false,
        "size": {
"example": "Death Slam"
            "label": "Size",
},
            "description": "Size of the icon link, defaulted to '15'px",
"alt_file_name": {
            "type": "number",
"label": "Alternate File Name",
            "required": false,
"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.",
            "example": "50"
"type": "string",
        }
"required": false,
    },
"example": "Amber Hand.png"
    "format": "inline"
},
"size": {
"label": "Size",
"description": "Size of the icon link, defaulted to '20'px",
"type": "number",
"required": false,
"example": "50"
},
"lang": {
"label": "Language",
"description": "An optional language code to override the default language suffix in links (e.g., '/ru', '/zh-hans'). If omitted, `If_lang` template is used.",
"example": "/ru",
"type": "string"
}
},
"format": "inline"
}
}
</templatedata>
</templatedata>
Please note that all contributions to The Deadlock Wiki are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see Deadlock:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Pages included on this page:

This page is a member of a hidden category:

Retrieved from "https://deadlock.wiki/Template:PageRef/doc"