Editing Template:Multiple image/doc

{{Lua|
* [[Module:Multiple image]]}}
==Description==
This template creates a box containing between two and ten images, arranged either vertically or horizontally and with captions for the entire box or per image.

With the appropriate choice of parameters, the template can automatically resize images to a given total width with each image having the same height.

'''Be aware''' that this template does ''not'' respect users' default image size preferences. If image size parameters are omitted, this template sets all images at 200px wide, regardless of whether the reader has set a preference for some other default image width. This causes multiple images to look out of scale to the other images in an article.

==Syntax and parameters==
Provide ''height[n]'' and ''total_width'' parameters to obtain automatic resizing.
Note the different meanings of the ''width[n]'' parameters with vs. without automatic resizing.
;No automatic resizing of all images to the same height
:<syntaxhighlight lang="xml">
{{multiple image
<!-- Layout parameters -->
 | align             = <!-- right (default), left, center, none --> 
 | direction         = <!-- horizontal (default), vertical -->
 | background color  = <!-- box background -->
 | width             = <!-- displayed width of each image in pixels (an integer, omit "px" suffix); overrides "width[n]"s below -->
 | caption_align     = <!-- left (default), center, right --> 

<!-- Header -->
 | header_background = 
 | header_align      = <!-- center (default), left, right -->
 | header            = 

<!--image 1-->
 | image1            = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
 | width1            = <!-- displayed width of image; overridden by "width" above -->
 | alt1              = 
 | link1             = 
 | thumbtime1        =
 | caption1          = 
<!--image 2-->
 | image2            = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
 | width2            = <!-- displayed width of image; overridden by "width" above -->
 | alt2              = 
 | link2             = 
 | thumbtime2        =
 | caption2          = 
<!-- and so on, to a maximum of 10 images (image10) -->

<!-- Footer -->
 | footer_background = 
 | footer_align      = <!-- left (default), center, right -->
 | footer            = 
}}
</syntaxhighlight>

;Automatic resizing of all images to the same height and to a given total width
:<syntaxhighlight lang="xml">
{{multiple image
<!-- Layout parameters -->
 | align             = <!-- right (default), left, center, none --> 
 | direction         = <!-- horizontal (default), vertical -->
 | background color  = <!-- box background -->
 | total_width       = <!-- total width of all the displayed images in pixels (an integer, omit "px" suffix) -->
 | caption_align     = <!-- left (default), center, right --> 

<!-- Header -->
 | header_background = 
 | header_align      = <!-- center (default), left, right -->
 | header            = 

<!--image 1-->
 | image1            = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
 | alt1              = 
 | link1             = 
 | thumbtime1        =
 | caption1          = 
<!--image 2-->
 | image2            = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
 | alt2              = 
 | link2             = 
 | thumbtime2        =
 | caption2          = 
<!-- and so on, to a maximum of 10 images (image10) -->

<!-- Footer -->
 | footer_background = 
 | footer_align      = <!-- left (default), center, right -->
 | footer            = 
}}
</syntaxhighlight>

{| class=wikitable
! Parameter !! Description
|-
| align          || right ''(default)'', left, center
|-
| direction      || horizontal ''(default)'', vertical
|-
| background color || To set [[wikipedia:List of colors|the background color]] of the box in which the images appear.
|-
| header_background || 
|-
| header_align   || center ''(default)'', left, right
|-
| header         || 
|-
| width          || Use to set the same width for each image (i.e. overrides any <code>width[n]</code> below). Do not include if different image widths intended, including if images are to be resized to a fixed total width.
|-
| total_width    || Use to scale the images to the same height and this total width. Do not use both <code>total_width</code> and <code>width</code>.
|-
| image''[n]''   || (where ''[n]'' = 1 to 10)&nbsp; Filename of [n]th image.
|-
| width''[n]''   || ''(as above)''&nbsp; Two meanings: (1) The width (in pixels, integer, omit "px") of [n]th image. Overridden by <code>width</code> (if set). (2) The full width of the original [n]th image if <code>total_width</code> is given in order to resize all images to the same height and a given total width.
|-
| height''[n]''   || ''(as above)''&nbsp; The full height of the original [n]th image if <code>total_width</code> is given in order to resize all images to the same height and a given total width. Ignored otherwise.
|-
| alt''[n]''     || ''(as above)''&nbsp; [[wikipedia:alt attribute|Alt description]] for [n]th image.
|-
| link''[n]''    || ''(as above)''&nbsp; To specify the page to which the [n]th image is linked (i.e. the page that is loaded when the image is clicked). If set as empty , linking is disabled.<br />'''''Note:''''' This parameter '''''must not''''' be used with images that have been given [[wikipedia:free license|free licenses]] (such as the [[wikipedia:GNU Free Documentation License|GDFL]] or a free [[wikipedia:Creative Commons license|CC license]]) as these licenses require images to be linked to a declaration of the license under which they are being used.
|-
| thumbtime''[n]'' || ''(as above)''&nbsp; When using Ogg Theora files, sets the time within the video that is used for the initial display. This is either a number of seconds or hours:minutes:seconds; see [[:c:Commons:Video#Setting a video thumbnail image]].
|-
| caption''[n]'' || ''(as above)''&nbsp; Caption for the [n]th image.
|-
| caption_align  || left ''(default)'', center, right
|-
| footer_background || 
|-
| footer_align   || left ''(default)'', center, right
|-
| footer         || Caption that spans the entire box, as opposed to individual images. Avoid "left" and "right" if possible, since mobile devices may [[#Using direction|display the images vertically]].
|}

==Examples==

{{multiple image
 | width = 60
 | image1 = Yellow card.svg
 | alt1 = Yellow cartouche
 | image2 = Red card.svg
 | alt2 = Red cartouche
 | footer = Players are cautioned with a yellow card and sent off with a red card.
}}
<pre>
{{multiple image
 | width = 60
 | image1 = Yellow card.svg
 | alt1 = Yellow cartouche
 | image2 = Red card.svg
 | alt2 = Red cartouche
 | footer = Players are cautioned with a yellow card and sent off with a red card.
}}
</pre>
{{clr}}
{{multiple image
 | align = left
 | direction = vertical
 | width = 200
 | header = [[wikipedia:Portable Network Graphics|PNG]] transparency demonstration
 | 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 overlaying a checkered background.
}}
<pre>
{{multiple image
 | align = left
 | direction = vertical
 | width = 200
 | header = [[wikipedia:Portable Network Graphics|PNG]] transparency demonstration
 | 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 overlaying a checkered background.
}}
</pre>
{{clear}}
{{multiple image
 | width = 60
 | image1=Ribbon numeral 2.png | alt1=2
 | image2=Ribbon numeral 3.png | alt2=3
 | image3=Ribbon numeral 4.png | alt3=4
 | footer = When a user has many of one type of barnstar, they can represent them with ribbons and these numerals to indicate the count.
}}
<pre>
{{multiple image
 | width = 60
 | image1=Ribbon numeral 2.png | alt1=2
 | image2=Ribbon numeral 3.png | alt2=3
 | image3=Ribbon numeral 4.png | alt3=4
 | footer = When a user has many of one type of barnstar, they can represent them with ribbons and these numerals to indicate the count.
}}
</pre>
{{clrr}}

===With ''background color''===
{{multiple image
 | align = left
 | background color = #BBDD99
 | width = 160
 | 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, in groups of three each with three lobes
 | footer_background = #BBDD99
 | footer_align = center
 | footer = [[wikipedia:Adoxa|Adoxa]] (''Adoxa moschatellina'')
}}
{{clear}}
<syntaxhighlight lang="moin" style="overflow:auto;">
{{multiple image
 | background color = #BBDD99
 | width = 160
 | 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, in groups of three each with three lobes
 | footer_background = #BBDD99
 | footer_align = center
 | footer = [[wikipedia:Adoxa|Adoxa]] (''Adoxa moschatellina'')
}}
</syntaxhighlight>
{{clear}}

===With links (''link[n]'')===
{{multiple image
 | align = left

 | image1 = Frecklesmule.jpg
 | width1 = 143
 | alt1 = A mule
 | link1 = Mule
 | caption1 = A mule<br />(骡子 ''luózi'')

 | image2 = Donkey 1 arp 750px.jpg
 | width2 = 150
 | alt2 = A donkey
 | link2 = 
 | caption2  = A donkey<br />(驴子 ''lǘzi'')

 | image3 = Rainbow_trout.png
 | width3 = 91
 | alt3 = A trout
 | caption3  = A fish<br />(鱼 ''yú'')

 | footer = The image of the mule links to [[wikipedia:Mule|Mule]]; the image of the donkey does not link anywhere; the image of the trout links to a standard image description page.
}}
{{clrl}}
<syntaxhighlight lang="moin" style="overflow:auto;">
{{multiple image
 | align = left

 | image1 = Frecklesmule.jpg
 | width1 = 143
 | alt1 = A mule
 | link1 = Mule
 | caption1 = A mule<br />(骡子 ''luózi'')

 | image2 = Donkey 1 arp 750px.jpg
 | width2 = 150
 | alt2 = A donkey
 | link2 = 
 | caption2  = A donkey<br />(驴子 ''lǘzi'')

 | image3 = Rainbow_trout.png
 | width3 = 91
 | alt3 = A trout
 | caption3  = A fish<br />(鱼 ''yú'')

 | footer = The image of the mule links to [[wikipedia:Mule|Mule]]; the image of the donkey does not link anywhere; the image of the trout links to a standard image description page.
}}
</syntaxhighlight>
{{clrr}}

===Using ''direction''===
By default, the images the template presents are displayed horizontally, as a row (see left; equivalent to setting <code>|direction=horizontal</code>). To display them vertically, i.e. as a column, set <code>direction=vertical</code> (see right).
{{multiple image
 |align=left |direction=horizontal |header=(horizontal) |width=60
 |image1=Ribbon numeral 2.png |image2=Ribbon numeral 3.png |image3=Ribbon numeral 4.png
}}
{{multiple image
 |align=right |direction=vertical |header=(vertical) |width=60
 |image1=Ribbon numeral 2.png |image2=Ribbon numeral 3.png |image3=Ribbon numeral 4.png
}}
{{clear}}
On mobile devices some images may always be displayed vertically if the total width is larger than around 320.

===To match image heights===
Note: The following is unnecessary if all the images presented by the template have the same [[wikipedia:Aspect ratio (image)|aspect ratio]]; if so, simply set <code>width</code> accordingly.
* Decide on a total width for all the images, say 320px
* Set the total width using <code>total_width</code>

{{multiple image
 | align = right
 | total_width = 320

 | image1 = Donkey 1 arp 750px.jpg
 | alt1 = A donkey
 | caption1 = Rectangular image of a donkey, originally 536 pixels high.

 | image2 = Rainbow_trout.png
 | alt2 = A trout
 | caption2 = Square image of a trout, originally 300 pixels high.

 | footer = Both images have been rendered with the same height, and a total width of 320px
}}
<pre>
{{multiple image
 | align = right
 | total_width = 320

 | image1 = Donkey 1 arp 750px.jpg
 | alt1 = A donkey
 | caption1 = Rectangular image of a donkey, originally 536 pixels high.

 | image2 = Rainbow_trout.png
 | alt2 = A trout
 | caption2 = Square image of a trout, originally 300 pixels high.

 | footer = Both images have been rendered with the same height, and a total width of 320px
}}
</pre>
{{clear}}
The aspect ratio of each image is automatically retrieved from the File metadata.  You can override the native width and height values by
* Examining the individual image pages to obtain the full resolution. For example:
** [[:File:Donkey 1 arp 750px.jpg]] shows "Donkey_1_arp_750px.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)"
* Specify the full width and height for each image, of the form:
** <code>width1</code> <code>height1</code> <code>width2</code> <code>height2</code>

=== Multiple rows ===
To create an array of images, with multiple rows, use <code>perrow</code>.  The value passed to <code>perrow</code> may be a single number, or a list of numbers delimited by <code>/</code>.  This feature may also be combined with <code>total_width</code> for multiple rows of images with the same total width.
{{multiple image|perrow = 2|total_width=300
| image1 = Kern_Theodolit_DKM2-A.jpg
| image2 = Total-Robotic-Station.jpg
| image3 = DumpyLevel.jpg
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.jpg
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, [[wikipedia:Real-time kinematic|RTK]] GPS Base station.
}}
<pre style="overflow:auto">
{{multiple image|perrow = 2|total_width=300
| image1 = Kern_Theodolit_DKM2-A.jpg
| image2 = Total-Robotic-Station.jpg
| image3 = DumpyLevel.jpg
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.jpg
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, [[wikipedia:Real-time kinematic|RTK]] GPS Base station.
}}
</pre>
{{clrr}}

=== Removing the image border ===
The border around the images can be removed using <code>image_style=border:none</code>.
{{multiple image
 | align = right
 | total_width = 320
 | image_style = border:none;

 | image1 = Donkey 1 arp 750px.jpg
 | alt1 = A donkey
 | caption1 = Image of a donkey

 | image2 = Rainbow_trout.png
 | alt2 = A trout
 | caption2 = Image of a trout
}}
<pre style="overflow:auto">
{{multiple image
 | align = right
 | total_width = 320
 | image_style = border:none;

 | image1 = Donkey 1 arp 750px.jpg
 | alt1 = A donkey
 | caption1 = Image of a donkey

 | image2 = Rainbow_trout.png
 | alt2 = A trout
 | caption2 = Image of a trout
}}</pre>
{{clrr}}

=== Increasing the gap between images ===
The gap between the images can be increased using <code>image_gap=N</code>, where N is the number of pixels (must be non-negative).
{{multiple image
 | align = right
 | total_width = 320
 | image_gap = 20

 | image1 = Donkey 1 arp 750px.jpg
 | alt1 = A donkey
 | caption1 = Image of a donkey

 | image2 = Rainbow_trout.png
 | alt2 = A trout
 | caption2 = Image of a trout
}}
<pre style="overflow:auto">
{{multiple image
 | align = right
 | total_width = 320
 | image_gap = 20

 | image1 = Donkey 1 arp 750px.jpg
 | alt1 = A donkey
 | caption1 = Image of a donkey

 | image2 = Rainbow_trout.png
 | alt2 = A trout
 | caption2 = Image of a trout
}}</pre>

==Credits==
This template and its documentation were taken from the [[wikipedia:Template:Multiple image|English Wikipedia]].

<noinclude>[[Category:Template documentation pages|{{PAGENAME}}]]</noinclude>
==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"description": "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.",
	"params": {
		"align": {
			"type": "string",
			"label": "Alignment",
			"default": "right",
			"description": "Sets text-wrapping around image box, where \"none\" places the box on the left edge with no text-wrapping, \"center\" places the box at center with no text-wrapping and \"left\" and \"right\" refer to position of box on screen with text-wrapping.",
			"example": "left/right/center/none",
			"suggested": true
		},
		"direction": {
			"default": "horizontal",
			"type": "string",
			"label": "Direction",
			"description": "Direction in which to tile the images.",
			"example": "horizontal/vertical",
			"suggested": true
		},
		"width": {
			"type": "string",
			"label": "Width",
			"description": "Width overrides Width 1, Width 2, Width 3, etc. If you want the images to be different sizes, do not provide the width parameter. Integer width in pixels; no \"px\" suffix",
			"example": "200",
			"suggested": true
		},
		"background color": {
			"type": "string",
			"label": "Background color",
			"description": "Defines the background color between the border of the box and the images."
		},
		"caption_align": {
			"default": "left",
			"type": "string",
			"label": "Caption alignment",
			"example": "left/right/center"
		},
		"header_background": {
			"type": "string",
			"label": "Header background"
		},
		"header_align": {
			"default": "center",
			"type": "string",
			"label": "Header alignment",
			"example": "left/right/center"
		},
		"header": {
			"type": "string",
			"label": "Header"
		},
		"image1": {
			"description": "Image 1 is name of first image. Similarly for Image 2, etc. File name only; no \"File:\" or \"Image:\" prefix.",
			"type": "string",
			"example": "example.jpg",
			"suggested": true,
			"label": "Image 1"
		},
		"width1": {
			"description": "width 1 is width of first image. Similarly for Width 2, etc.",
			"type": "number",
			"label": "Width 1"
		},
		"alt1": {
			"type": "string",
			"description": "The alt text for first image. Similarly for Alt text 2, etc.",
			"label": "Alt text 1"
		},
		"caption1": {
			"type": "string",
			"description": "Caption 1 is caption of first image. Similarly for Caption 2, etc.",
			"suggested": true,
			"label": "Caption 1"
		},
		"link1": {
			"type": "wiki-page-name",
			"description": "Where the first page links to. Similarly for Link 2, 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. 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.",
			"label": "Link 1"
		},
		"thumbtime1": {
			"type": "string",
			"description": "If image1 is an Ogg Theora file, sets the time within the video that is used for the initial display. Either a number of seconds or hours:minutes:seconds. Similarly for Thumb time 2, etc.",
			"label": "Thumbtime 1"
		},
		"image2": {
			"example": "example.jpg",
			"suggested": true,
			"label": "Image 2",
			"type": "string"
		},
		"width2": {
			"type": "number",
			"label": "Width 2"
		},
		"alt2": {
			"label": "Alt text 2",
			"type": "string"
		},
		"caption2": {
			"type": "string",
			"suggested": true,
			"label": "Caption 2"
		},
		"link2": {
			"type": "wiki-page-name",
			"label": "Link 2"
		},
		"thumbtime2": {
			"type": "string",
			"label": "Thumbtime 2"
		},
		"image3": {
			"type": "string",
			"example": "example.jpg",
			"label": "Image 3"
		},
		"width3": {
			"type": "number",
			"label": "Width 3"
		},
		"alt3": {
			"type": "string",
			"label": "Alt text 3"
		},
		"caption3": {
			"label": "Caption 3",
			"type": "string"
		},
		"link3": {
			"label": "Link 3",
			"type": "wiki-page-name"
		},
		"thumbtime3": {
			"type": "string",
			"label": "Thumbtime 3"
		},
		"footer_background": {
			"type": "string",
			"label": "Footer background"
		},
		"footer_align": {
			"default": "left",
			"type": "string",
			"label": "Footer alignment",
			"example": "left/right/center"
		},
		"footer": {
			"type": "string",
			"label": "Footer"
		}
	},
	"format": "block"
}
</templatedata>