Module:InfoboxImage/doc
This is the documentation page for Module:InfoboxImage
| Warning | This Lua module is used on approximately 3,980,000 pages, or roughly 322528% of all pages. 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. Consider discussing 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 image |
| title | Title text for image. If blank then alt text is used. |
| border | If yes, then a border is added. |
| upright | upright image param. |
| center | If yes, then the image is centered. |
| thumbtime | thumbtime param, used for video clips. |
| suppressplaceholder | If yes then will suppress certain placeholder images. |
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|}}}|sizedefault=frameless|alt={{{alt|}}}}}
Examples
| {{#invoke:InfoboxImage|InfoboxImage}} | |
| {{#invoke:InfoboxImage|InfoboxImage|image=}} | |
| {{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}} | File:Abbey Rd Studios.jpg |
|
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}} |
File:Abbey Rd Studios.jpg |
|
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} |
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|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=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}} | 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=Abbey Rd Studios.jpg|maxsize=100px|center=yes}} |
