Module:InfoboxImage/doc: Difference between revisions

Revision as of 19:28, 8 December 2016

Latest revision as of 13:29, 14 May 2025

(37 intermediate revisions by 29 users not shown)

Line 1:

{{used in system}}

{{High-risk|2,860,000}}

{{Module rating|protected}}

==Overview==

Line 13 ⟶ 14:

|-

| size

| Size to display image, in pixels. Use is discouraged per [[WP:THUMBSIZE]]; see {{Para|upright}} below instead.

|-

| maxsize

Line 25 ⟶ 26:

|-

| title

| Title text for image (mousehovermouseover text). If blank then alt text is used.

|-

| border

Line 31 ⟶ 32:

|-

| 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 220px250px 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

Line 47 ⟶ 48:

| link

| Page to go to when clicking on the image.

|}-

| class

| HTML classes to add to the image.

|}

Note: If you specify the maxsize or sizedefault params, then you should include the px after the number.

{{Use dmy dates|date=July 2016}}

==Parameters displayed in image syntax==

All parameters:

:<presyntaxhighlight 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}}} }}</presyntaxhighlight>

:<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):

:<presyntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250250px }}</presyntaxhighlight>

:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250250px }}</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):

:<presyntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250250px | maxsize=200200px }}</presyntaxhighlight>

:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250250px | maxsize=200200px }}</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):

:<presyntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=250256px }}</presyntaxhighlight>

:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=250256px }}</code>

When "size", "sizedefault", and "maxsize" are not defined, "frameless" is added, which displays the image at the default thumbnail size (220px250px, but logged in users can change this at [[Special:Preferences]]) and is required if using "upright" to scale the default size:

:<presyntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</presyntaxhighlight>

:<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):

:<presyntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</presyntaxhighlight>

:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</code>

When "alt" is used without "title", the alt text is also used as the title:

:<presyntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</presyntaxhighlight>

:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</code>

Line 84 ⟶ 87:

==Sample usage==

<presyntaxhighlight lang="wikitext" style="overflow:auto;">

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

</syntaxhighlight>

</pre>

==Examples==

{| class="wikitable"

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}</nowiki>}}

| {{#invoke:InfoboxImage|InfoboxImage|image=}}

|-

|

<nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg}}</nowiki><br />

<nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}File:Abbey Rd Studios.jpg}}</nowiki><br />

<nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Image:Abbey Rd Studios.jpg}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}}

|-

|

<nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|upright{{=}}yes}}</nowiki><br />

| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=yes}}

|-

|

<nowiki>{{#invoke:mlx|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:mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size{{=}}100px}}</nowiki><br />

<nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size{{=}}100}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=[[Image}}{{elc|File:Abbey Rd Studios.jpg|200px]]}}</nowiki>}}

| {{#invoke:InfoboxImage|InfoboxImage|image=[[ImageFile:Abbey Rd Studios.jpg|200px]]}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|sizedefault=250px200px}}|alttitle{{=The front stairs and door of }}Abbey Road Studios!}}</nowiki>

| {{#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}}

| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|sizedefault{{=250px}}250|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=250|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|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:mlx|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:mlx|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:mlx|InfoboxImage|InfoboxImage|image{{=}}Bandera de Bilbao.svg|size{{=}}100|border{{=}}yes}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=Bandera de Bilbao.svg|size=200|border=yes}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Image is needed male.svg}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Image is needed male.svg|suppressplaceholder{{=}}no}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=[[}}{{elc|File:Image is needed male.svg|200px]]}}</nowiki>}}

| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=[[}}{{elc|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:mlx|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:mlx|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:mlx|InfoboxImage|InfoboxImage|image{{=[[}}{{elc|File:Abbey Rd Studios.jpg|200px]]}}|maxsize{{=}}100px}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|maxsize=100px}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|maxsize{{=}}100px|center{{=}}yes}}</nowiki>

| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}}

|-

| <nowiki>{{#invoke:mlx|InfoboxImage|InfoboxImage|image{{=}}no such image|maxsize{{=}}100px|center{{=}}yes}}</nowiki><!-- this issue sh'd be fixed somewhow-->

| {{#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 ==

{{div col|colwidth=22em}}

{|

* [[:File:ReplaceBlue - replace this image female (blue).svg]]

| style="vertical-align:top;" |

* [[:File:Blue - Replacereplace this image femalemale.svg]]

* [[:File:BlueMale -no Replace thisfree image maleyet.svgpng]]

* [[:File:Female no free image yet.png]]

* [[:File:Flag of None (square).svg]]

* [[:File:Flag of None.svg]]

* [[:File:Flag of.svg]]

* [[:File:Green - Replacereplace this image female.svg]]

* [[:File:Green - Replacereplace this image male.svg]]

* [[:File:Image is needed female.svg]]

* [[:File:Image is needed male.svg]]

Line 183 ⟶ 193:

* [[:File:No portrait (female).svg]]

* [[:File:No portrait (male).svg]]

* [[:File:Red - Replacereplace this image female.svg]]

* [[:File:Red - Replacereplace 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 - Replacereplace this image female.svg]]

* [[:File:Silver - Replacereplace this image male.svg]]

* [[:File:Replace this image.svg]]

* [[:File:Cricket no pic.png]]

Line 201 ⟶ 210:

* [[:File:NoDVDcover copy.png]]

* [[:File:Noribbon.svg]]

| style="vertical-align:top;" |

* [[:File:No portrait-BFD-test.svg]]

* [[:File:Placeholder barnstar ribbon.png]]

Line 236 ⟶ 244:

* [[:File:Project Trains no image.png]]

* [[:File:Image-request.png]]

{{div col end}}

* [[:File:NoImageHere-Computers.jpg]]

|}

== Tracking categories ==

* {{clc|Pages using deprecated image syntax}}

* {{clc|Pages using infoboxes with thumbnail images}}

* {{clc|Pages using deprecatedinfoboxes with URL in image syntaxparameter}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandboxSandbox other||

{{DEFAULTSORT:Image, {{PAGENAME}}}}

[[Category:Lua metamodules]]

[[Category:Modules for image handling]]

[[Category:Modules that add a tracking category]]

[[Category:LuaInfobox metamodulesmodules]]

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>