Template:Multiple image/doc

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. (Image use policy states: "Except with very good reason, do not use "... "which forces a fixed image width." MOS:IMGSIZE states that a fixed width in pixels may only be specified, "Where absolutely necessary.")

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. Please also note the option to set a total_width parameter at the beginning of the multiple image template.
 * No automatic resizing of all images to the same height


 * Automatic resizing of all images to the same height and to a given total width

Using direction
By default, the images the template presents are displayed horizontally, as a row (see left; equivalent to setting ). To display them vertically, i.e. as a column, set (see right).

On mobile devices some images may always be displayed vertically if the total width is larger than around 320.

To match image heights

 * Decide on a total width for all the images, say 320px
 * Set the total width using total_width


 * Using the  and   parameters.

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:
 * width1 height1 width2 height2

Multiple rows
To create an array of images, with multiple rows, use perrow. The value passed to perrow may be a single number, or a list of numbers delimited by. This feature may also be combined with total_width for multiple rows of images with the same total width.



Removing the image border
The border around the images can be removed using border:none.



Increasing the gap between images
The gap between the images can be increased using N, where N is the number of pixels (must be non-negative).



TemplateData
{	"description": "This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box and each image.", "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", "suggestedvalues": [ "left", "center", "right", "none" ]		},		"direction": { "default": "horizontal", "type": "string", "label": "Direction", "description": "Direction in which to tile the images.", "example": "horizontal/vertical", "suggested": true, "suggestedvalues": [ "horizontal", "vertical" ]		},		"total_width": { "type": "number", "label": "Frame width", "description": "Use to scale the images to the same height and this total width. Do not use both total_width and width. Integer width in pixels; no \"px\" suffix", "example": "400", "suggested": true },		"perrow": { "type": "string", "label": "Row layout", "description": "Create an array of images, with multiple rows. The value passed to may be a single number or a list of numbers with each row delimited by /. Can be combined with total_width for automatic sizing of images.", "example": "1 / 2 / 1" },		"width": { "type": "number", "label": "Image 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" },		"background color": { "type": "string", "label": "Background color", "description": "Defines the background color between the border of the box and the images. Changing the background can be bad for accessibility, avoid when possible.", "example": "#EEFFGG or red" },		"caption_align": { "default": "left", "type": "string", "label": "Caption alignment", "example": "left/right/center", "suggestedvalues": [ "left", "center", "right" ]		},		"image1": { "description": "Image 1 is name of first image. Similarly for Image 2, etc. File name only; no \"File:\" or \"Image:\" prefix.", "type": "wiki-file-name", "example": "example.jpg", "suggested": true, "required": 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": "line", "description": "The alt text of first image (see WP:ALT). Similarly for Alt text 2, etc.", "label": "Alt text 1", "suggested": true },		"caption1": { "type": "content", "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": "wiki-file-name" },		"width2": { "type": "number", "label": "Width 2" },		"alt2": { "label": "Alt text 2", "type": "line" },		"caption2": { "type": "content", "suggested": true, "label": "Caption 2" },		"link2": { "type": "wiki-page-name", "label": "Link 2" },		"thumbtime2": { "type": "string", "label": "Thumbtime 2" },		"image3": { "type": "wiki-file-name", "example": "example.jpg", "label": "Image 3" },		"width3": { "type": "number", "label": "Width 3" },		"alt3": { "type": "line", "label": "Alt text 3" },		"caption3": { "label": "Caption 3", "type": "content" },		"link3": { "label": "Link 3", "type": "wiki-page-name" },		"thumbtime3": { "type": "string", "label": "Thumbtime 3" },		"image_gap": { "type": "number", "label": "Image gap", "description": "Override the distance between adjacent images. Integer width in pixels; no \"px\" suffix", "example": "20" },		"image_style": { "type": "string", "label": "Image style", "description": "Override the default styling of the image frame." },		"header": { "type": "content", "label": "Header", "description": "A header text to place above the entire frame." },		"header_background": { "type": "string", "label": "Header background", "description": "Defines the background color of the header field. Changing the background can be bad for accessibility, avoid when possible", "example": "#EEFFGG or red" },		"header_align": { "default": "center", "type": "string", "label": "Header alignment", "example": "left/right/center" },		"footer": { "type": "content", "label": "Footer", "description": "Caption that spans the entire box, as opposed to individual images. Avoid \"left\" and \"right\" if possible, since mobile devices may display the images vertically." },		"footer_background": { "type": "string", "label": "Footer background", "description": "Defines the background color of the footer field. Changing the background can be bad for accessibility, avoid when possible", "example": "#EEFFGG or red" },		"footer_align": { "default": "left", "type": "string", "label": "Footer alignment", "example": "left/right/center", "suggestedvalues": [ "left", "center", "right" ]		},		"border": { "example": "infobox", "label": "Alignment within an Infobox" }	},	"format": "block" }