Template:multiple images/documentation

This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box or for each 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. (w:Wikipedia:Image use policy states: "Except with very good reason, do not use "... "which forces a fixed image width. In most cases should be used, thereby respecting the user's base preference (which may have been selected for that user's particular devices).")

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

 * 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).

To match image heights

 * Note: The following is unnecessary if all the images presented by the template have the same aspect ratio; if so, simply set width accordingly.


 * Decide on a total width for all the images, say 320px
 * 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)"
 * Specify the full width and height for each image, of the form:
 * width1 height1 width2 height2
 * Set the total width using total_width

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.

TemplateData
TemplateData for  {	"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." },		"header": { "type": "string", "label": "Header" },		"footer": { "type": "string", "label": "Footer" },		"caption_align": { "default": "left", "type": "string", "label": "Caption alignment", "example": "left/right/center" },		"header_align": { "default": "center", "type": "string", "label": "Header alignment", "example": "left/right/center" },		"footer_align": { "default": "left", "type": "string", "label": "Footer alignment", "example": "left/right/center" },		"header_background": { "type": "string", "label": "Header background" },		"footer_background": { "type": "string", "label": "Footer background" },		"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 of first image (see WP:ALT on Wikipedia). 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": "string", "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 as per WP:ALT on Wikipedia.\nImportant: 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" },		"image2": { "example": "example.jpg", "suggested": true, "label": "Image 2", "type": "string" },		"width2": { "type": "string", "label": "Width 2" },		"alt2": { "label": "Alt text 2", "type": "string" },		"caption2": { "type": "string", "suggested": true, "label": "Caption 2" },		"link2": { "type": "string", "label": "Link 2" },		"image3": { "type": "string", "example": "example.jpg", "label": "Image 3" },		"width3": { "type": "string", "label": "Width 3" },		"alt3": { "type": "string", "label": "Alt text 3" },		"caption3": { "label": "Caption 3", "type": "string" },		"link3": { "label": "Link 3", "type": "string" }	},	"format": "block" }