Login
Login

Module:InfoboxImage/doc

{{used in system}}

{{Module rating|protected}}

Overview

This module is used within infoboxes to process the image parameters and tidy up the formatting of the result.

Parameters

class="wikitable"

! Parameter

! Description

image

| Required. The main parameter that should be passed over which contains the image info.

size

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

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 (mouseover text).

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

| 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 {{section link

Placeholder images which can be suppressed}}.
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.

Parameters displayed in image syntax

All parameters:

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

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

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=250px }}

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

:{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}

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=256px }}

:{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=256px }}

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:

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

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

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

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

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

:{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}

:{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}

For more information, see Wikipedia:Extended image syntax.

Sample usage

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

Examples

class="wikitable"
{{mlx|InfoboxImage|InfoboxImage}}

| {{#invoke:InfoboxImage|InfoboxImage}}

{{mlx|InfoboxImage|InfoboxImage|image{{=}}}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg}}

{{mlx|InfoboxImage|InfoboxImage|image{{=}}File:Abbey Rd Studios.jpg}}

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Image:Abbey Rd Studios.jpg}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|upright{{=}}yes}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|upright{{=}}1.2}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size{{=}}100px}}

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size{{=}}100}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}|title{{=}}Abbey Road!}}

| {{#invoke:InfoboxImage|InfoboxImage|image=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}}

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

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

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

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Bandera de Bilbao.svg|size{{=}}100|border{{=}}yes}}

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

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

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Image is needed male.svg|200px}}}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Image is needed male.svg|200px}}|suppressplaceholder{{=}}no}}

| {{#invoke:InfoboxImage|InfoboxImage|image=200px|suppressplaceholder=no}}

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size=50px|maxsize{{=}}100px}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size=200px|maxsize{{=}}100px}}

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

{{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}|maxsize{{=}}100px}}

| {{#invoke:InfoboxImage|InfoboxImage|image=200px|maxsize=100px}}

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

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

{{mlx|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

{{div col|colwidth=22em}}

{{div col end}}

Tracking categories

  • {{clc|Pages using infoboxes with thumbnail images}}
  • {{clc|Pages using infoboxes with URL in image parameter}}

{{Sandbox other||

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

Category:Modules for image handling

Category:Modules that add a tracking category

Category:Infobox modules

}}

Category:Module documentation pages