Module:InfoboxImage: Difference between revisions

Jump to navigation Jump to search
old>WOSlinker
No edit summary
old>WOSlinker
No edit summary
Line 15: Line 15:
         local alt = frame.args["alt"];
         local alt = frame.args["alt"];
         local result = "";
         local result = "";
       
        if (tonumber(size) or 0) > 0 then
            size = size .. "px";
        end
          
          
         result = "File:" .. frame.args["image"];
         result = "File:" .. frame.args["image"];

Revision as of 20:45, 28 August 2012

Overview

This module is used within infoboxes to process the image parameters and tidy up the formatting of the result.

Parameters

Parameter Description
image Required. The main parameter that should be passed over which contains the image info.
size Size to display image, in pixels. Use is discouraged per WP:THUMBSIZE; see |upright= below instead.
maxsize Maximum size to display image. Note: If no size or sizedefault params specified then image will be shown at maxsize.
sizedefault The size to use for the image if no size param is specified. Defaults to frameless.
alt Alt text for the image.
title Title text for image (mouseover text).
border If yes, then a border is added.
page The page number to be displayed when using a multi-page image.
upright If upright=yes, adds "upright" which displays image at 75% of default image size (which is 220px if not changed at Special:Preferences). If a value, adds "upright=value" to image, where values less than 1 scale the image down (0.9 = 90%) and values greater than 1 scale the image up (1.15 = 115%).
center If yes, then the image is centered.
thumbtime thumbtime param, used for video clips.
suppressplaceholder If no, then will not suppress certain placeholder images. See § Placeholder images which can be suppressed.
link Page to go to when clicking on the image.
class HTML classes to add to the image.

Note: If you specify the maxsize or sizedefault params, then you should include the px after the number.

Parameters displayed in image syntax

All parameters:

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}} }}
File:{{{image}}}/{{{size}}}

When "size" and "maxsize" are defined, the smaller of the two is used (if "px" is omitted it will be added by the module):

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}
File:{{{image}}}/300px

When "size" is not defined, "sizedefault" is used, even if larger than "maxsize" (in actual use "px" is required after the number; omitted here to show it is not added by the module):

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}
File:{{{image}}}/250px

When "size" and "sizedefault" are not defined, "maxsize" is used (in actual use "px" is required after the number; omitted here to show it is not added by the module):

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=250px }}
File:{{{image}}}/frameless

When "size", "sizedefault", and "maxsize" are not defined, "frameless" is added, which displays the image at the default thumbnail size (220px, but logged in users can change this at Special:Preferences) and is required if using "upright" to scale the default size:

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}
File:{{{image}}}/frameless

Use of "upright" without a number value, which displays the image at approximately 75% of the user's default size (multiplied by 0.75 then rounded to nearest 10):

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}
File:{{{image}}}/frameless

When "alt" is used without "title", the alt text is also used as the title:

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}
File:{{{image}}}/frameless

For more information, see Wikipedia:Extended image syntax.

Sample usage

|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}

Examples

Template:Mlx
Template:Mlx

Template:Mlx
Template:Mlx
Template:Mlx

File:Abbey Rd Studios.jpg/frameless

Template:Mlx

File:Abbey Rd Studios.jpg/frameless

Template:Mlx

File:Abbey Rd Studios.jpg/frameless

Template:Mlx
Template:Mlx

File:Abbey Rd Studios.jpg/100px
Template:Mlx Abbey Rd Studios.jpg
Template:Mlx Abbey Rd Studios.jpg
Template:Mlx File:Abbey Rd Studios.jpg/250px
Template:Mlx File:Abbey Rd Studios.jpg/250
Template:Mlx File:Abbey Rd Studios.jpg/250px
Template:Mlx File:Abbey Rd Studios.jpg/frameless
Template:Mlx File:Abbey Rd Studios.jpg/100px
Template:Mlx File:Bandera de Bilbao.svg/200px
Template:Mlx File:Image is needed male.svg/frameless
Template:Mlx File:Image is needed male.svg/frameless
Template:Mlx Image is needed male.svg
Template:Mlx Image is needed male.svg
Template:Mlx File:Abbey Rd Studios.jpg/50px
Template:Mlx File:Abbey Rd Studios.jpg/200px
Template:Mlx Abbey Rd Studios.jpg
Template:Mlx File:Abbey Rd Studios.jpg/frameless
Template:Mlx File:no such image/frameless
Template:Mlx File:
/frameless

Placeholder images which can be suppressed

Tracking categories


local i = {};

function i.InfoboxImage(frame)
    local image = frame.args["image"];
    
    if image == "" or image == nil then
        return ""
    end
    
    if string.sub(frame.args["image"],1,2) == "[[" then
        return frame.args["image"];
    else
        local size = frame.args["size"];
        local sizedefault = frame.args["sizedefault"];
        local alt = frame.args["alt"];
        local result = "";
        
        if (tonumber(size) or 0) > 0 then
            size = size .. "px";
        end
        
        result = "File:" .. frame.args["image"];
        result = result .. "/" .. (size or sizedefault or "frameless");
        
        return result;
    end
end

return i;