Template:Click/doc

This is a documentation subpage for Template:Click.
It contains usage information, categories, and other content that is not part of the original template page.

Using this template is deprecated to new wiki syntax: [[File:Example.jpg|link=Link title]] will just work the same as {{click|image=Example.jpg|link=Link title}}

This template employs intricate features of the template syntax.

Please do not attempt to alter it unless you are certain that you understand the setup and are prepared to repair/revert any consequent collateral damage if the results are unexpected. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the or your user space before changing anything here.

Usage

To use this template, simply copy the text below and replace the text between the <...> with the desired result.

{{Click
|image  = <image to be linked>
|size   = <size of the image> 
|width  = <width of the image> DEPRECATED
|height = <height of the image, optional> DEPRECATED
|link   = <page the image must link to>
|title  = <the label for the image, optional>
|desc   = <location of a description link, optional> DEPRECATED
}}

The image parameter specifies the image to be used. It defaults to Image:Transparent.gif when not specified.
The size parameter specified the maximum size of the image, either in the format «width»x«height»px, «width»px, or x«height»px.
~~The width parameter specifies the maximum width the image should be scaled to. It defaults to the default size of the image when not specified. Do not add "px" to the value.~~ DEPRECATED
~~The height parameter specifies the maximum height the image should be scaled to. It defaults to the default size of the image when not specified. Do not add "px" to the value.~~ DEPRECATED
The link parameter specifies the page to which the image should link. It defaults to the Main Page when not specified.
The title parameter specifies text to be used in the tooltip (text which appears on hovering the mouse over the image) and as alternative text if the image fails to load. It is entirely optional, and defaults to the text of the title of the page to which the image links.
The desc parameter specifies a location where an icon linking to the description page for the image can be placed. It is entirely optional, and can take any of the following values: top-right, bottom-right, bottom-left, top-left, or none to disable it completely. It defaults to none when not specified. DEPRECATED

For example, the following code generates:

{{Click
 |image  = Example.png
 |size   = 250px
 |link   = Example
 |title  = This is an example image.
 }}