Module:InfoboxImage/doc: Difference between revisions
m Reverted edits by Yasukothanh (talk) to last version by Alakzi |
add section with parameters displayed in image syntax |
||
| Line 6: | Line 6: | ||
==Parameters== | ==Parameters== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Parameter | ! Parameter | ||
!Description | ! Description | ||
|- | |- | ||
|image | | image | ||
|Required. The main parameter that should be passed over which contains the image info. | | Required. The main parameter that should be passed over which contains the image info. | ||
|- | |- | ||
|size | | size | ||
|Size to display image. | | Size to display image. | ||
|- | |- | ||
|maxsize | | maxsize | ||
|Maximum size to display image. Note: If no size or sizedefault params specified then image will be shown at maxsize. | | Maximum size to display image. Note: If no size or sizedefault params specified then image will be shown at maxsize. | ||
|- | |- | ||
|sizedefault | | sizedefault | ||
|The size to use for the image if no size param is specified. Defaults to [[Wikipedia:Autosizing images|frameless]]. | | The size to use for the image if no size param is specified. Defaults to [[Wikipedia:Autosizing images|frameless]]. | ||
|- | |- | ||
|alt | | alt | ||
|Alt text for the image. | | Alt text for the image. | ||
|- | |- | ||
|title | | title | ||
|Title text for image (mousehover text). If blank then alt text is used. | | Title text for image (mousehover text). If blank then alt text is used. | ||
|- | |- | ||
|border | | border | ||
|If yes, then a border is added. | | If yes, then a border is added. | ||
|- | |- | ||
|upright | | 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 | | 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 | | center | ||
|If yes, then the image is centered. | | If yes, then the image is centered. | ||
|- | |- | ||
|thumbtime | | thumbtime | ||
|thumbtime param, used for video clips. | | thumbtime param, used for video clips. | ||
|- | |- | ||
|suppressplaceholder | | suppressplaceholder | ||
|If yes then will suppress certain placeholder images. | | If yes then will suppress certain placeholder images. | ||
|- | |- | ||
|link | | link | ||
|Page to go to when clicking on the image. | | 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. | Note: If you specify the maxsize or sizedefault params, then you should include the px after the number. | ||
==Parameters displayed in image syntax== | |||
Usage: | |||
<pre style="overflow:auto;"> | |||
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | |||
| size={{{size}}} | upright={{{upright}}} | alt={{{alt}}} | |||
| title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | |||
}} | |||
</pre> | |||
Output:<br /> | |||
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | |||
| size={{{size}}} | upright={{{upright}}} | alt={{{alt}}} | |||
| title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | |||
}} | |||
For more information, see [[WIkipedia:Extended image syntax]]. | |||
==Sample usage== | ==Sample usage== | ||
| Line 56: | Line 73: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage}}</nowiki> | | <nowiki>{{#invoke:InfoboxImage|InfoboxImage}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage}} | | {{#invoke:InfoboxImage|InfoboxImage}} | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=}}</nowiki> | | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=}} | | {{#invoke:InfoboxImage|InfoboxImage|image=}} | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}}</nowiki> | | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}} | | {{#invoke:InfoboxImage|InfoboxImage|image=[[Image:Abbey Rd Studios.jpg|200px]]}} | ||
|- | |- | ||
| | | | ||
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}}</nowiki><br/> | <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=File:Abbey Rd Studios.jpg}}</nowiki><br /> | ||
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Image:Abbey Rd Studios.jpg}}</nowiki> | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Image:Abbey Rd Studios.jpg}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}} | ||
|- | |- | ||
| | | | ||
<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}}</nowiki><br/> | <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> | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}</nowiki> | | <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}} | | {{#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> | | <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}} | | {{#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> | | <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}} | | {{#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> | | <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}} | | {{#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> | | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=100|border=yes}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=200|border=yes}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Bilbao.svg|size=200|border=yes}} | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Replace this image male.svg|suppressplaceholder=yes}}</nowiki> | | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Replace this image male.svg|suppressplaceholder=yes}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=Replace this image male.svg|suppressplaceholder=yes}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Replace this image male.svg|suppressplaceholder=yes}} | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:replace this image male.svg|200px]]|suppressplaceholder=yes}}</nowiki> | | <nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:replace this image male.svg|200px]]|suppressplaceholder=yes}}</nowiki> | ||
|{{#invoke:InfoboxImage|InfoboxImage|image=[[Image:replace this image male.svg|200px]]|suppressplaceholder=yes}} | | {{#invoke:InfoboxImage|InfoboxImage|image=[[Image:replace this image male.svg|200px]]|suppressplaceholder=yes}} | ||
|- | |- | ||
|<nowiki>{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=50px|maxsize=100px}}</nowiki> | | <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}} | | {{#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> | | <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}} | | {{#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> | | <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}} | | {{#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> | | <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}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}} | ||
|} | |} | ||
Revision as of 23:56, 3 September 2015
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.
Parameters displayed in image syntax
Usage:
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}}
| size={{{size}}} | upright={{{upright}}} | alt={{{alt}}}
| title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}}
}}
Output:
[[File:{{{image}}}|{{{size}}}|alt={{{alt}}}|link={{{link}}}|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=[[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|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=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=[[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}} |
Tracking/maintenance category