Module:InfoboxImage/doc: Difference between revisions
m 1 revision imported |
see |
||
| Line 1: | Line 1: | ||
{{used in system}} | {{used in system}} | ||
{{Module rating|protected}} | {{Module rating|protected}} | ||
{{for|guide on extended image syntax used in wikitext|Wikipedia:Extended image syntax}} | |||
==Overview== | ==Overview== | ||
This module is used within infoboxes to process the image parameters and tidy up the formatting of the result. | This module is used within infoboxes to process the image parameters and tidy up the formatting of the result. | ||
| Line 14: | Line 14: | ||
|- | |- | ||
| size | | size | ||
| Size to display image. | | Size to display image, in pixels. Use is discouraged per [[WP:THUMBSIZE]]; see {{Para|upright}} below instead. | ||
|- | |- | ||
| maxsize | | maxsize | ||
| Line 35: | Line 35: | ||
|- | |- | ||
| upright | | upright | ||
| If upright=yes, adds "upright" which displays image at 75% of default image size (which is | | If upright=yes, adds "upright" which displays image at 75% of default image size (which is 250px 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 | | center | ||
| Line 54: | Line 54: | ||
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== | ==Parameters displayed in image syntax== | ||
All parameters: | All parameters: | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}} }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}}}}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}}}}</code> | ||
When "size" and "maxsize" are defined, the smaller of the two is used (if "px" is omitted it will be added by the module): | When "size" and "maxsize" are defined, the smaller of the two is used (if "px" is omitted it will be added by the module): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}</code> | ||
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): | 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): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}</code> | ||
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): | 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): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=256px }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize= | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=256px }}</code> | ||
When "size", "sizedefault", and "maxsize" are not defined, "frameless" is added, which displays the image at the default thumbnail size ( | When "size", "sizedefault", and "maxsize" are not defined, "frameless" is added, which displays the image at the default thumbnail size (250px, but logged in users can change this at [[Special:Preferences]]) and is required if using "upright" to scale the default size: | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</code> | ||
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): | 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): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</code> | ||
When "alt" is used without "title", the alt text is also used as the title: | When "alt" is used without "title", the alt text is also used as the title: | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</code> | ||
| Line 89: | Line 87: | ||
==Sample usage== | ==Sample usage== | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="wikitext" style="overflow:auto;"> | ||
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}} | |image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}} | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 121: | Line 119: | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} | ||
|- | |- | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc| | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}}} | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=[[ | | {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]}} | ||
|- | |- | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc| | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}|title{{=}}Abbey Road!}} | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=[[ | | {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|title=Abbey Road!}} | ||
|- | |- | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|sizedefault{{=}}250px|alt{{=}}The front stairs and door of Abbey Road Studios}} | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|sizedefault{{=}}250px|alt{{=}}The front stairs and door of Abbey Road Studios}} | ||
| Line 148: | Line 146: | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}} | ||
|- | |- | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Image is needed male.svg|suppressplaceholder=no}} | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}Image is needed male.svg|suppressplaceholder{{=}}no}} | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}} | ||
|- | |- | ||
| Line 171: | Line 169: | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}no such image|maxsize{{=}}100px|center{{=}}yes}}<!-- this issue sh'd be fixed somewhow--> | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}no such image|maxsize{{=}}100px|center{{=}}yes}}<!-- this issue sh'd be fixed somewhow--> | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=no such image|maxsize=100px|center=yes}} | | {{#invoke:InfoboxImage|InfoboxImage|image=no such image|maxsize=100px|center=yes}} | ||
|- | |||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{tji|Multiple image|width: 60|image1: Yellow card.svg|image2: Red card.svg}}}} | |||
| {{#invoke:InfoboxImage|InfoboxImage|image={{multiple image|width=50|image1=Yellow card.svg|image2=Red card.svg}}}} | |||
|} | |} | ||
== Placeholder images which can be suppressed == | == Placeholder images which can be suppressed == | ||
{| | {{div col|colwidth=22em}} | ||
* [[:File:Blue - replace this image female.svg]] | * [[:File:Blue - replace this image female.svg]] | ||
* [[:File:Blue - replace this image male.svg]] | * [[:File:Blue - replace this image male.svg]] | ||
* [[:File:Male no free image yet.png]] | * [[:File:Male no free image yet.png]] | ||
* [[:File:Flag of None (square).svg]] | * [[:File:Flag of None (square).svg]] | ||
| Line 196: | Line 195: | ||
* [[:File:Red - replace this image female.svg]] | * [[:File:Red - replace this image female.svg]] | ||
* [[:File:Red - replace this image male.svg]] | * [[:File:Red - replace this image male.svg]] | ||
* [[:File:Replace this image female.svg]] | * [[:File:Replace this image female.svg]] | ||
* [[:File:Replace this image male (blue).svg]] | * [[:File:Replace this image male (blue).svg]] | ||
| Line 212: | Line 210: | ||
* [[:File:NoDVDcover copy.png]] | * [[:File:NoDVDcover copy.png]] | ||
* [[:File:Noribbon.svg]] | * [[:File:Noribbon.svg]] | ||
* [[:File:No portrait-BFD-test.svg]] | * [[:File:No portrait-BFD-test.svg]] | ||
* [[:File:Placeholder barnstar ribbon.png]] | * [[:File:Placeholder barnstar ribbon.png]] | ||
| Line 247: | Line 244: | ||
* [[:File:Project Trains no image.png]] | * [[:File:Project Trains no image.png]] | ||
* [[:File:Image-request.png]] | * [[:File:Image-request.png]] | ||
{{div col end}} | |||
== Tracking categories == | == Tracking categories == | ||
* {{clc|Pages using infoboxes with thumbnail images}} | * {{clc|Pages using infoboxes with thumbnail images}} | ||
* {{clc|Pages using infoboxes with URL in image parameter}} | |||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
| Line 257: | Line 255: | ||
[[Category:Modules that add a tracking category]] | [[Category:Modules that add a tracking category]] | ||
[[Category:Infobox modules]] | [[Category:Infobox modules]] | ||
}}</includeonly> | }}</includeonly><noinclude> | ||
[[Category:Module documentation pages]] | |||
</noinclude> | |||