Module:InfoboxImage/doc
Jump to navigation
Jump to search
This is the documentation page for Module:InfoboxImage
 | This Lua module is used on 1,800,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. |
Contents
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. |
| upright | upright image param. This should be supplied as a number. For example upright=0.9 sets the image as 90% of default image size |
| center | If yes, then the image is centered. |
| thumbtime | thumbtime param, used for video clips. |
| suppressplaceholder | If yes then will suppress certain placeholder images. |
| 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.
Sample Usage
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|size={{{image_size|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}
Examples
| {{#invoke:InfoboxImage|InfoboxImage}} | |
| {{#invoke:InfoboxImage|InfoboxImage|image=}} | |
| {{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}} | 
|
|
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}} |
|
|
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} |
|
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=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}} |
|
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|alt=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}} |
|
| {{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=100|border=yes}} | 
|
| {{#invoke:InfoboxImage|InfoboxImage|image=Replace this image male.svg|suppressplaceholder=yes}} | |
| {{#invoke:InfoboxImage|InfoboxImage|image=[[Image:replace this image male.svg|200px]]|suppressplaceholder=yes}} | |
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=50px|maxsize=100px}} |
|
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=200px|maxsize=100px}} |
|
| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|maxsize=100px}} |
|
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}} | |
