Template:Multiple image/doc

From SPCodex, The Smashing Pumpkins wiki

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.

Parameters[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Multiple image

This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box and each image.
ParameterDescriptionTypeStatus
Alignmentalign
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.
Default
right
Example
left/right/center/none
Stringsuggested
Directiondirection
Direction in which to tile the images.
Default
horizontal
Example
horizontal/vertical
Stringsuggested
Frame widthtotal_width
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
Numbersuggested
Row layoutperrow
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
Stringoptional
Image widthwidth
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
Numberoptional
Background colorbackground color
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
Stringoptional
Caption alignmentcaption_align
Default
left
Example
left/right/center
Stringoptional
Image 1image1
Image 1 is name of first image. Similarly for Image 2, etc. File name only; no "File:" or "Image:" prefix.
Example
example.jpg
Filerequired
Width 1width1
Width 1 is width of first image. Similarly for Width 2, etc.
Numberoptional
Alt text 1alt1
The alt text of first image. Similarly for Alt text 2, etc.
Linesuggested
Caption 1caption1
Caption 1 is caption of first image. Similarly for Caption 2, etc.
Contentsuggested
Link 1link1
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.
Page nameoptional
Thumbtime 1thumbtime1
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.
Stringoptional
Image 2image2
Example
example.jpg
Filesuggested
Width 2width2Numberoptional
Alt text 2alt2Lineoptional
Caption 2caption2Contentsuggested
Link 2link2Page nameoptional
Thumbtime 2thumbtime2Stringoptional
Image 3image3
Example
example.jpg
Fileoptional
Width 3width3Numberoptional
Alt text 3alt3Lineoptional
Caption 3caption3Contentoptional
Link 3link3Page nameoptional
Thumbtime 3thumbtime3Stringoptional
Image gapimg_gap
Override the distance between adjacent images. Integer width in pixels; no "px" suffix
Example
20
Numberoptional
Image styleimage_style
Override the default styling of the image frame.
Stringoptional
Headerheader
A header text to place above the entire frame.
Contentoptional
Header backgroundheader_background
Defines the background color of the header field. Changing the background can be bad for accessibility, avoid when possible
Example
#EEFFGG or red
Stringoptional
Header alignmentheader_align
Default
center
Example
left/right/center
Stringoptional
FooterfooterContentoptional
Footer backgroundfooter_background
Defines the background color of the footer field. Changing the background can be bad for accessibility, avoid when possible
Example
#EEFFGG or red
Stringoptional
Footer alignmentfooter_align
Default
left
Example
left/right/center
Stringoptional

Format: block