Template:Multiple image

Template documentation

[view] [edit] [history] [purge]

This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box and/or for each images.

Usage

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Multiple image

This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box and/or for each images.

Template parameters

Parameter		Description	Type	Status
Align	align	left/right/center/none Default right	String	optional
Direction	direction	horizontal/vertical Default horizontal	String	optional
Width	width	width overrides width1, width2, width3, etc. If you want the images to be different sizes, do not provide the width parameter. Integer width in pixels; no 'px' suffix	String	optional
Background color	background color	defines the background color between the border of the box and the images.	String	optional
Header	header	no description	String	optional
Footer	footer	no description	String	optional
Header align	header_align	left/right/center Default center	String	optional
Footer align	footer_align	left/right/center Default left	String	optional
Header background	header_background	no description	String	optional
Footer background	footer_background	no description	String	optional
image1	image1	image1 is name of first image. Similarly for image2, etc. File name only; no 'File:' or 'Image:' prefix.	String	optional
width1	width1	width1 is width of first image. Similarly for width2, etc.	Number	optional
alt1	alt1	alt1 is [[alt text]] of first image (see [[WP:ALT]]). Similarly for alt2, etc.	String	optional
caption1	caption1	caption1 is caption of first image. Similarly for caption2, etc.	String	optional
link1	link1	is where the first page links to. Similarly for link2, etc. If not specified, image links to the image description page as usual. If specified to the empty value, the image does not link anywhere; this should be used for purely decorative images as per [[WP:ALT]]. Important: If the image is under a free license like the GFDL or a CC license, you must not use this parameter as the terms of those licenses require the license, or a link to it, to be reproduced with the image. The image must, therefore, link to its image page. Public domain and (theoretically) fair use images are not subject to this restriction.	Page name	optional
image2	image2	no description	Unknown	optional
width2	width2	no description	Unknown	optional
alt2	alt2	no description	Unknown	optional
caption2	caption2	no description	Unknown	optional
link2	link2	no description	Unknown	optional
image3	image3	no description	Unknown	optional
width3	width3	no description	Unknown	optional
alt3	alt3	no description	Unknown	optional
caption3	caption3	no description	Unknown	optional
link3	link3	no description	Unknown	optional

• align defaults to "right"
• direction defaults to "horizontal"
• header_align defaults to "center"
• footer_align defaults to "left"
• image1 is name of first image. Similarly for image2, etc.
• width1 is width of first image. Similarly for width2, etc.
  • width overrides width1, width2, width3, etc. If you want the images to be different sizes, do not provide the width parameter.
• alt1 is alt text of first image (see WP:ALT). Similarly for alt2, etc.
• caption1 is caption of first image. Similarly for caption2, etc.
• link1 is where the first page links to. Similarly for link2, etc. If not specified, image links to the image description page as usual. If specified to the empty value, the image does not link anywhere; this should be used for purely decorative images as per WP:ALT.
  Important: If the image is under a free license like the GFDL or a CC license, you must not use this parameter as the terms of those licenses require the license, or a link to it, to be reproduced with the image. The image must, therefore, link to its image page. Public domain and (theoretically) fair use images are not subject to this restriction.
• background color defines the background color between the border of the box and the images.
• header, footer, background color and captions are optional.

{{multiple image
<!-- Essential parameters -->
| align     = <!-- left/right/center/none --> 
| direction = <!-- horizontal/vertical -->
| width     = <!-- integer width in pixels; no "px" suffix -->

<!-- Image 1 -->
| image1    = <!-- file name only; no "File:" or "Image:" prefix -->
| width1    = 
| alt1      = 
| caption1  = 

<!-- Image 2 -->
| image2    = <!-- file name only; no "File:" or "Image:" prefix -->
| width2    = 
| alt2      = 
| caption2  = 

<!-- Image 3 -->
| image3    = <!-- file name only; no "File:" or "Image:" prefix -->
| width3    = 
| alt3      = 
| caption3  =

<!-- up to |image10 is accepted -->

<!-- Extra parameters -->
| header            = 
| header_align      = <!-- left/right/center -->
| header_background = 
| footer            = 
| footer_align      = <!-- left/right/center -->
| footer_background = 
| background color  = 
}}

Examples

Players are cautioned with a yellow card and sent off with a red card.

{{multiple image
| footer    = Players are cautioned with a yellow card and sent off with a red card.
| width     = 60

| image1    = Yellow card.svg
| alt1      = Yellow cartouche

| image2    = Red card.svg
| alt2      = Red cartouche
}}

PNG transparency demonstration

A PNG image with an 8-bit transparency layer...

...here overlaid onto a checkered background.

{{multiple image
| align     = left
| direction = vertical
| header    = [[PNG]] transparency demonstration
| width     = 200

| image1    = PNG transparency demonstration 1.png
| alt1      = Colored dice with white background
| caption1  = A PNG image with an 8-bit transparency layer...

| image2    = PNG transparency demonstration 2.png
| alt2      = Colored dice with checkered background
| caption2  = ...here overlaid onto a checkered background.
}}

When a user has many of one type of barnstar,

they can represent them with ribbons

and these numerals to indicate the count.

{{multiple image
| footer   = When a user has many of one type of [[WP:BARN|barnstar]],
they can represent them with [[WP:RIBBON|ribbons]]
and these numerals to indicate the count.
| width    = 60

| image1   = Ribbon numeral 2.png
| alt1     = 2

| image2   = Ribbon numeral 3.png
| alt2     = 3

| image3   = Ribbon numeral 4.png
| alt3     = 4
}}

Example with background color

Adoxa (Adoxa moschatellina)

{{multiple image
| image1=Adoxa_moschatellina_210406.jpg
| alt1=Green herb with a few tiny yellow-white flowers

| image2=Adoxa_moschatellina_210406a.jpg
| alt2=Three small white and yellow flowers before green-leaf background

| image3=adoxa_moschatellina_blatt.jpeg
| alt3=Leaves of a plant. They are in groups of three, each with three lobes.

| footer=[[Adoxa]] (''Adoxa moschatellina'')
| footer_background=#BBDD99
| background color=#BBDD99
| footer_align=center
| width=160
}}

Example with links

A mule
骡子, luózi

A donkey
驴子, lǘzi

A fish
鱼, yú

The mule links to Mule, the donkey does not link anywhere, and the trout links to its image description page as usual.

{{multiple image
| footer    = The mule links to ''[[Mule]]'', the donkey does not link anywhere, and the trout links to its image description page as usual.
| align     = left

| image1    = Frecklesmule.jpg
| width1    = 143
| alt1      = A mule
| caption1  = <div style="text-align: center;">A mule<br />骡子, ''luózi''</div>
| link1     = Mule

| image2    = Donkey in Clovelly, North Devon, England.jpg
| width2    = 150
| alt2      = A donkey
| caption2  = <div style="text-align: center;">A donkey<br />驴子, lǘzi</div>
| link2     =

| image3    = Rainbow_trout.png
| width3    = 91
| alt3      = A trout
| caption3  = <div style="text-align: center;">A fish<br />
{{lang|zh|2=鱼}}, ''yú''</div>
}}

Horizontal placement

Vertical direction places the images on one column, while horizontal direction places the images on one row:

vertical

horizontal

Matching image heights

This trick is not required if all images have the same aspect ratio, where |width= suffices

• Decide on a common height for the images, say 100 pixels.
• Examine the individual image pages to obtain the full resolution. For example:
  • File:Donkey in Clovelly, North Devon, England.jpg shows "Donkey in Clovelly, North Devon, England.jpg (750 × 536 pixels, file size: 125 KB, MIME type: image/jpeg)"
  • File:Rainbow trout.png shows "Rainbow_trout.png (300 × 300 pixels, file size: 158 KB, MIME type: image/png)"
• For non-square images, use these figures to construct an expression for the |widthn= parameters, of the form:
  • {{#expr: (dh * ow / oh) round 0}}
• where
  • dh is the desired height in pixels (100)
  • ow is the original width in pixels (750 or 300)
  • oh is the original height in pixels (536 or 300)
• For square images, simply set the appropriate |widthn= to be the desired height. If all are square, only |width= needs to be set.

A donkey, not square and originally 536 pixels high

A fish, square and originally 300 pixels high

The two images are both rendered 100 pixels high

{{multiple image
| footer    = The two images are both rendered 100 pixels high
| align     = right

| image1    = Donkey in Clovelly, North Devon, England.jpg
| width1    = {{#expr: (100 * 750 / 536) round 0}}
| alt1      = A donkey
| caption1  = A donkey, not square and originally 536 pixels high

| image2    = Rainbow_trout.png
| width2    = 100
| alt2      = A trout
| caption2  = A fish, square and originally 300 pixels high
}}

The above documentation is transcluded from Template:Multiple image/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.