Template:Name/doc

From Welcome to Elderfield Wiki
Jump to navigation Jump to search

Usage

This template displays an icon and link based on the input name. Default icon size is 32px.
An optional quantity can be displayed in parentheses after the item name.
Image, links, and link display name can also be optionally customized.

Parameters

{{Name|1 = |2 = (optional)|3 = (optional)|4 = (optional)|size = (optional)|image = (optional)|link = (optional)|class = (optional)|ext = (optional)|br = y (optional)}}

Fields

{ "params": { "1": { "description": "Required. Item name. Used for the page link and image filename.", "example": "Bones", "label": "1 Item name", "required": true }, "2": { "description": "Optional. Displays the value before the item image and name. ", "example": "5", "label": "2 Quantity/text" }, "3": { "description": "Optional. Changes the link target.", "example": "Brain", "label": "3 Page name" }, "4": { "description": "Optional. Changes the displayed text. ", "example": "Visera", "label": "4 Display label" }, "class": { "description": "Optional. Suppresses line breaks.", "example": "inline" }, "image": { "description": "Optional. Uses a custom image.", "example": "Tooth.png" }, "ext": { "description": "Optional. Changes the image extension. Default is png. Only use if item image uploaded to wiki is not png. ", "example": "jpg" }, "size": { "description": "Optional. Changes the icon size.", "example": "48", "label": "Icon Size" }, "link": { "description": "Optional. Overrides the link target. ", "example": "Wishbone" }, "br": { "description": "Adds a line break between the image and the link.", "suggestedvalues": [ "y" ] } }, "paramOrder": [ "1", "2", "3", "4", "size", "image", "link", "class", "ext", "br" ] }

Examples

Default

{{Name|Bones}}

displays...
Saved Name content
{{Name|Bones}}

This component is preserved in source form.


Custom Quantity

{{Name|Bones|5}}

displays...
Saved Name content
{{Name|Bones|5}}

This component is preserved in source form.


link=

{{Name|Bones|link=Brain}}

Parameter 3

{{Name|Bones||Brain}}

both display...
Saved Name content
{{Name|Bones|link=Brain}}

This component is preserved in source form.


This only works when using parameter 3 instead of link=
Use this if you need to link to a custom page while also changing the display name. 
{{Name|Bones||Tools|Example}}

displays...
Saved Name content
{{Name|Bones||Tools|Example}}

This component is preserved in source form.

while linking to Tools.

Image

Easier to just change the link and use the item name as parameter 1, but this can be used if you wish to change the image manually. 
{{Name|Bones|image=Brain.png}}

displays...
Saved Name content
{{Name|Bones|image=Brain.png}}

This component is preserved in source form.


Image Size

{{Name|Bones|size=48}}

displays...
Saved Name content
{{Name|Bones|size=48}}

This component is preserved in source form.