Module:InfoboxImage/doc: Difference between revisions
m (1 revision imported) |
(No difference)
|
Latest revision as of 09:01, 11 July 2016
File:Ambox warning orange.svg | This Lua module is used on 2,825,000 pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any 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 (mousehover 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
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes }}
[[File:{{{image}}}|{{{size}}}|center|alt={{{alt}}}|link={{{link}}}|border|upright={{{upright}}}|thumbtime={{{thumbtime}}}|{{{title}}}]]
For more information, see Wikipedia:Extended image syntax.
Sample usage
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}
Examples
{{#invoke:InfoboxImage|InfoboxImage}} | |
{{#invoke:InfoboxImage|InfoboxImage|image=}} | |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}} |
File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=yes}} |
File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=1.2}} |
File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} |
File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}} | The front stairs and door of Abbey Road Studios |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios|title=Exterior, front view of Abbey Road studios}} | The front stairs and door of Abbey Road Studios |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|alt=The front stairs and door of Abbey Road Studios}} | The front stairs and door of Abbey Road Studios |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px|alt=The front stairs and door of Abbey Road Studios}} | The front stairs and door of Abbey Road Studios |
{{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=100|border=yes}} | File:Bilbao.svg |
{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}} | |
{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}} | File:Image is needed male.svg |
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]}} | |
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]|suppressplaceholder=no}} | File:Image is needed male.svg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=50px|maxsize=100px}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=200px|maxsize=100px}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|maxsize=100px}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}} |
Placeholder images which can be suppressed
Tracking/maintenance category