Editing Template:Plink/doc

{{Documentation}}
The '''picture link''' template creates an image and links it to the page as well as including text.

This template is not intended to be commonly used in mainspace articles. It is primarily used in navboxes and tables to add images to help with navigation. In most other cases, pages should be linked with normal markup and without an image.

==Usage==
<pre>{{plink|item|pic=file name|txt=text}}</pre>

==Examples==
{|class="wikitable"
|+ Examples
!Code
! style="min-width:150px;" | Produces
!Standard syntax
|-
|<code><nowiki>{{plink|Bucket}}</nowiki></code>
|{{plink|Bucket}}
|<code><nowiki>[[File:Bucket.png|link=Bucket]] [[Bucket]]</nowiki></code>
|-
|<code><nowiki>{{plink|Bucket|size=50}}</nowiki></code>
|{{plink|Bucket|size=50}}
|<code><nowiki>[[File:Bucket.png|50px|link=Bucket]] [[Bucket]]</nowiki></code>
|-
|<code><nowiki>{{plink|Bottle|pic=Bucket}}</nowiki></code>
|{{plink|Bottle|pic=Bucket}}
|<code><nowiki>[[File:Bucket.png|link=Bottle]] [[Bottle]]</nowiki></code>
|-
|<code><nowiki>{{plink|Bucket|txt=Bottle}}</nowiki></code>
|{{plink|Bucket|txt=Bottle}}
|<code><nowiki>[[File:Bucket.png|link=Bucket]] [[Bucket|Bottle]]</nowiki></code>
|-
|<code><nowiki>{{plink|Bottle|pic=Bucket|txt=Bottle}}</nowiki></code>
|{{plink|Bottle|pic=Bucket|txt=Bottle}}
|<code><nowiki>[[File:Bucket.png|link=Bottle]] [[Bottle|Bottle]]</nowiki></code>
|}

==Parameters==
<templatedata>
{
    "description": "The 'Picture Link' (plink) template is used to create item image + text links.",
    "params": {
        "1": {
            "label": "Item",
            "description": "The item to link to and display",
            "type": "wiki-page-name",
            "required": true
        },
        "pic": {
            "label": "Picture",
            "description": "The name of the image file; do not include 'File:' or '.png'",
            "default": "First parameter",
            "type": "wiki-file-name"
        },
        "txt": {
            "label": "Text override",
            "description": "Override the displayed link text.",
            "default": "First parameter",
            "type": "string"
        },
        "size": {
            "label": "Size",
            "description": "Sets custom size (in px).",
            "type": "number"
        }
    }
}
</templatedata>

<includeonly>[[Category:Link creating templates|{{PAGENAME}}]]</includeonly>