Template:Doc

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
{   "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": "Align", "default": "right", "description": "left/right/center/none" },       "direction": { "default": "horizontal", "type": "string", "label": "Direction", "description": "horizontal/vertical" },       "width": { "type": "string", "label": "Width", "description": "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" },       "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" },       "header_align": { "default": "center", "type": "string", "label": "Header align", "description": "left/right/center" },       "footer_align": { "default": "left", "type": "string", "label": "Footer align", "description": "left/right/center" },       "header_background": { "type": "string", "label": "Header background" },       "footer_background": { "type": "string", "label": "Footer background" },       "image1": { "description": "image1 is name of first image. Similarly for image2, etc. File name only; no 'File:' or 'Image:' prefix.", "type": "string" },       "width1": { "description": "width1 is width of first image. Similarly for width2, etc. ", "type": "number" },       "alt1": { "type": "string", "description": "alt1 is alt text of first image (see WP:ALT). Similarly for alt2, etc." },       "caption1": { "type": "string", "description": "caption1 is caption of first image. Similarly for caption2, etc." },       "link1": { "type": "string/wiki-page-name", "description": "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.\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." },       "image2": {}, "width2": {}, "alt2": {}, "caption2": {}, "link2": {}, "image3": {}, "width3": {}, "alt3": {}, "caption3": {}, "link3": {} } }

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.
 * 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.
 * background color defines the background color between the border of the box and the images.
 * header, footer, background color and captions are optional.



Examples






Example with background color


Example with links


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

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 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)"
 * For non-square images, use these figures to construct an expression for the widthn parameters, of the form:
 * 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.
 * For square images, simply set the appropriate widthn to be the desired height. If all are square, only width needs to be set.

