Difference between revisions of "Module:InfoboxImage/doc"

From Amateur Radio Equipment Database
Jump to: navigation, search
m (1 revision imported: Imported wikipedia infobox)
(removed Wikipedia examples and list of dummy images)
 
Line 87: Line 87:
 
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}
 
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}
 
</pre>
 
</pre>
 
==Examples==
 
{| class="wikitable"
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=}}
 
|-
 
|
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}}</nowiki><br />
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=File:Abbey Rd Studios.jpg}}</nowiki><br />
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Image:Abbey Rd Studios.jpg}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}}
 
|-
 
|
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=yes}}</nowiki><br />
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=yes}}
 
|-
 
|
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=1.2}}</nowiki><br />
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=1.2}}
 
|-
 
|
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}}</nowiki><br />
 
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}
 
|-
 
| <nowiki>{{#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}}</nowiki>
 
| {{#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}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|alt=The front stairs and door of Abbey Road Studios}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|alt=The front stairs and door of Abbey Road Studios}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px|alt=The front stairs and door of Abbey Road Studios}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px|alt=The front stairs and door of Abbey Road Studios}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=100|border=yes}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=200|border=yes}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]|suppressplaceholder=no}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]|suppressplaceholder=no}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=50px|maxsize=100px}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=50px|maxsize=100px}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=200px|maxsize=100px}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=200px|maxsize=100px}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|maxsize=100px}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|maxsize=100px}}
 
|-
 
| <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}}</nowiki>
 
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}}
 
|}
 
 
== Placeholder images which can be suppressed ==
 
{|
 
| style="vertical-align:top;" |
 
* [[:File:Blue - Replace this image female.svg]]
 
* [[:File:Blue - Replace this image male.svg]]
 
* [[:File:Female no free image yet.png]]
 
* [[:File:Flag of None (square).svg]]
 
* [[:File:Flag of None.svg]]
 
* [[:File:Flag of.svg]]
 
* [[:File:Green - Replace this image female.svg]]
 
* [[:File:Green - Replace this image male.svg]]
 
* [[:File:Image is needed female.svg]]
 
* [[:File:Image is needed male.svg]]
 
* [[:File:Location map of None.svg]]
 
* [[:File:Male no free image yet.png]]
 
* [[:File:Missing flag.png]]
 
* [[:File:No flag.svg]]
 
* [[:File:No free portrait.svg]]
 
* [[:File:No portrait (female).svg]]
 
* [[:File:No portrait (male).svg]]
 
* [[:File:Red - Replace this image female.svg]]
 
* [[:File:Red - Replace this image male.svg]]
 
* [[:File:Replace this image female (blue).svg]]
 
* [[:File:Replace this image female.svg]]
 
* [[:File:Replace this image male (blue).svg]]
 
* [[:File:Replace this image male.svg]]
 
* [[:File:Silver - Replace this image female.svg]]
 
* [[:File:Silver - Replace this image male.svg]]
 
* [[:File:Replace this image.svg]]
 
* [[:File:Cricket no pic.png]]
 
* [[:File:CarersLogo.gif]]
 
* [[:File:Diagram Needed.svg]]
 
* [[:File:Example.jpg]]
 
* [[:File:Image placeholder.png]]
 
* [[:File:No male portrait.svg]]
 
* [[:File:Nocover-upload.png]]
 
* [[:File:NoDVDcover copy.png]]
 
* [[:File:Noribbon.svg]]
 
| style="vertical-align:top;" |
 
* [[:File:No portrait-BFD-test.svg]]
 
* [[:File:Placeholder barnstar ribbon.png]]
 
* [[:File:Project Trains no image.png]]
 
* [[:File:Image-request.png]]
 
* [[:File:Sin bandera.svg]]
 
* [[:File:Sin escudo.svg]]
 
* [[:File:Replace this image - temple.png]]
 
* [[:File:Replace this image butterfly.png]]
 
* [[:File:Replace this image.svg]]
 
* [[:File:Replace this image1.svg]]
 
* [[:File:Resolution angle.png]]
 
* [[:File:Image-No portrait-text-BFD-test.svg]]
 
* [[:File:Insert image here.svg]]
 
* [[:File:No image available.png]]
 
* [[:File:NO IMAGE YET square.png]]
 
* [[:File:NO IMAGE YET.png]]
 
* [[:File:No Photo Available.svg]]
 
* [[:File:No Screenshot.svg]]
 
* [[:File:No-image-available.jpg]]
 
* [[:File:Null.png]]
 
* [[:File:PictureNeeded.gif]]
 
* [[:File:Place holder.jpg]]
 
* [[:File:Unbenannt.JPG]]
 
* [[:File:UploadACopyrightFreeImage.svg]]
 
* [[:File:UploadAnImage.gif]]
 
* [[:File:UploadAnImage.svg]]
 
* [[:File:UploadAnImageShort.svg]]
 
* [[:File:CarersLogo.gif]]
 
* [[:File:Diagram Needed.svg]]
 
* [[:File:No male portrait.svg]]
 
* [[:File:NoDVDcover copy.png]]
 
* [[:File:Placeholder barnstar ribbon.png]]
 
* [[:File:Project Trains no image.png]]
 
* [[:File:Image-request.png]]
 
* [[:File:NoImageHere-Computers.jpg]]
 
|}
 
  
 
== Tracking/maintenance category ==
 
== Tracking/maintenance category ==

Latest revision as of 18:41, 14 April 2017

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

All parameters:

{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | 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=250 }}
[[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=250 | maxsize=200 }}
[[File:{{{image}}}|250]]

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=250 }}
[[File:{{{image}}}|250]]

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|Alt text]]

For more information, see Wikipedia:Extended image syntax.

Sample usage

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

Tracking/maintenance category