Template:Image/doc

From The Stars Above Mod Wiki
Jump to navigation Jump to search

If the filename is passed without its extension, will determine if a gif is available (defaults to png); returns the image; if file exists as neither gif nor png, returns a null value.

If the filename includes an extension, will check if the file exists, returning null if it doesn't.

Usage

{{image|options|caption}}

Parameters

All [[File:]] syntax is valid.

In addition:

size =

Overrides the unnamed size option. Supports *scale syntax. Example: |20px|size=40px*0.75 will parse as 40px*0.75, results in 30px

scale =

Scales the image based on its size. e.g. scale=0.5.

maxsize =

Uses the same syntax as the [[File:]]'s size option: Wpx, Hpx, or WxHpx. Note: this is applied AFTER scale.

redlink =

For files that do not exist, this template outputs nothing by default. If this parameter is set, this template will output red link for the file.

Examples

code result expected expensive calls
{{image|Boltstorm Axe.png}} Boltstorm Axe.png (image) 0
{{image|Boltstorm Boltstorm.png}} (blank) 0
{{image|Boltstorm Boltstorm.png|redlink=y}} File:Boltstorm Boltstorm.png (red link) 0
{{image|Boltstorm Boltstorm}} (blank) 1
{{image|Boltstorm Axe}} Boltstorm Axe.png (image) 1