This is the documentation page for Module:InfoboxImage
 | This Lua module is used in system messages, and on approximately 4,080,000 pages, or roughly 680000% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
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.
|
| 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). If blank then alt text is used.
|
| 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.
|
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}}} }}[[File:{{{image}}}|page={{{page}}}|{{{size}}}|center|alt={{{alt}}}|link={{{link}}}|border|upright={{{upright}}}|thumbtime={{{thumbtime}}}|{{{title}}}]]
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}}}|250px]]
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}}}|250px]]
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|upright]]
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|alt=Alt text]]
For more information, see Wikipedia:Extended image syntax.
Sample usage
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}
Examples
Placeholder images which can be suppressed
Tracking categories
