Template:PageRef/doc - Revision history

Gammaton32: more details

2026-05-14T13:59:04Z

more details

← Older revision		Revision as of 13:59, 14 May 2026
Line 1:		Line 1:
	Note: ~~Please~~ use {{tl\|HeroIcon}}, {{tl\|AbilityIcon}}, or {{tl\|ItemIcon}} instead.		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.

Mgpt: Added note. It might take a while to replace now.

2026-05-02T21:14:29Z

Added note. It might take a while to replace now.

← Older revision		Revision as of 21:14, 2 May 2026
Line 1:		Line 1:
			Note: Please use {{tl\|HeroIcon}}, {{tl\|AbilityIcon}}, or {{tl\|ItemIcon}} instead.
	=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.

Gammaton32 at 14:52, 28 February 2026

2026-02-28T14:52:52Z

← Older revision		Revision as of 14:52, 28 February 2026
Line 88:		Line 88:
	"size": {		"size": {
	"label": "Size",		"label": "Size",
	"description": "Size of the icon link, defaulted to '15'px",		"description": "Size of the icon link, defaulted to '20'px",
	"type": "number",		"type": "number",
	"required": false,		"required": false,

Monster Domosed: added lang parameter to doc

2025-12-09T03:51:53Z

added lang parameter to doc

← Older revision		Revision as of 03:51, 9 December 2025
Line 39:		Line 39:
	<code><nowiki>{{PageRef\|My cool page\|no_file=true}}</nowiki></code>		<code><nowiki>{{PageRef\|My cool page\|no_file=true}}</nowiki></code>
	{{PageRef\|My cool page\|no_file=true}}		{{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=		=Parameters=
Line 54:		Line 58:
	"type": "string"		"type": "string"
	},		},
	"no_file": {		"no_file": {
	"label": "Do not use file",		"label": "Do not use file",
	"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",		"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",
	"required": false,		"required": false,
	"example": "true",		"example": "true",
	"type": "string"		"type": "string"
	},		},
	"alt_name": {		"alt_name": {
	"label": "Alternate Name",		"label": "Alternate Name",
Line 88:		Line 92:
	"required": false,		"required": false,
	"example": "50"		"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"
	}		}
	},		},

Gammaton32 at 04:46, 11 April 2025

2025-04-11T04:46:51Z

← Older revision		Revision as of 04:46, 11 April 2025
Line 14:		Line 14:
	** 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=

Gammaton32 at 04:40, 11 April 2025

2025-04-11T04:40:10Z

← Older revision		Revision as of 04:40, 11 April 2025
Line 9:		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 (~~light~~)		** The .png should at least be default theme compatible (dark)
	** 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

Gammaton32: /* Examples */

2025-01-10T03:37:43Z

Examples

← Older revision		Revision as of 03:37, 10 January 2025
Line 18:		Line 18:
	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\|~~Amber Hand~~}}</nowiki></code> {{PageRef\|~~Amber Hand~~}}		Example where the icon doesn't exist: <code><nowiki>{{PageRef\|Shopkeeper}}</nowiki></code> {{PageRef\|Shopkeeper}}

	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}}

Sur: no_file param prep

2024-12-22T05:23:34Z

no_file param prep

← Older revision		Revision as of 05:23, 22 December 2024
Line 31:		Line 31:

	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
			{{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}}

	=Parameters=		=Parameters=

	<templatedata>		<templatedata>
	{		{
Line 47:		Line 53:
	"type": "string"		"type": "string"
	},		},
			"no_file": {
			"label": "Do not use file",
			"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",
			"required": false,
			"example": "true",
			"type": "string"
			},
	"alt_name": {		"alt_name": {
	"label": "Alternate Name",		"label": "Alternate Name",

Gammaton32 at 19:13, 28 November 2024

2024-11-28T19:13:39Z

← Older revision		Revision as of 19:13, 28 November 2024
Line 44:		Line 44:
	"aliases": [		"aliases": [
	"1"		"1"
	]		],
			"type": "string"
	},		},
	"alt_name": {		"alt_name": {

Gammaton32 at 18:29, 28 November 2024

2024-11-28T18:29:30Z

← Older revision		Revision as of 18:29, 28 November 2024
Line 40:		Line 40:
	"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.",
	~~"type": "string",~~
	"required": true,		"required": true,
	"example": "Lash",		"example": "Lash",

← Older revision		Revision as of 03:37, 10 January 2025
Line 18:		Line 18:
	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\|~~Amber Hand~~}}</nowiki></code> {{PageRef\|~~Amber Hand~~}}		Example where the icon doesn't exist: <code><nowiki>{{PageRef\|Shopkeeper}}</nowiki></code> {{PageRef\|Shopkeeper}}

	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}}