Template:Multiple image/doc
This is a documentation subpage for Template:Multiple image. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template uses TemplateStyles: |
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Alignment | align | 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.
| String | suggested |
Direction | direction | Direction in which to tile the images.
| String | suggested |
Frame width | total_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
| Number | suggested |
Row layout | perrow | 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.
| String | optional |
Image width | width | 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
| Number | optional |
Background color | background 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.
| String | optional |
Caption alignment | caption_align |
| String | optional |
Image 1 | image1 | Image 1 is name of first image. Similarly for Image 2, etc. File name only; no "File:" or "Image:" prefix.
| File | required |
Width 1 | width1 | Width 1 is width of first image. Similarly for Width 2, etc. | Number | optional |
Alt text 1 | alt1 | The alt text of first image. Similarly for Alt text 2, etc. | Line | suggested |
Caption 1 | caption1 | Caption 1 is caption of first image. Similarly for Caption 2, etc. | Content | suggested |
Link 1 | link1 | 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 name | optional |
Thumbtime 1 | thumbtime1 | 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. | String | optional |
Image 2 | image2 |
| File | suggested |
Width 2 | width2 | Number | optional | |
Alt text 2 | alt2 | Line | optional | |
Caption 2 | caption2 | Content | suggested | |
Link 2 | link2 | Page name | optional | |
Thumbtime 2 | thumbtime2 | String | optional | |
Image 3 | image3 |
| File | optional |
Width 3 | width3 | Number | optional | |
Alt text 3 | alt3 | Line | optional | |
Caption 3 | caption3 | Content | optional | |
Link 3 | link3 | Page name | optional | |
Thumbtime 3 | thumbtime3 | String | optional | |
Image gap | img_gap | Override the distance between adjacent images. Integer width in pixels; no "px" suffix
| Number | optional |
Image style | image_style | Override the default styling of the image frame. | String | optional |
Header | header | A header text to place above the entire frame. | Content | optional |
Header background | header_background | Defines the background color of the header field. Changing the background can be bad for accessibility, avoid when possible
| String | optional |
Header alignment | header_align |
| String | optional |
Footer | footer | Content | optional | |
Footer background | footer_background | Defines the background color of the footer field. Changing the background can be bad for accessibility, avoid when possible
| String | optional |
Footer alignment | footer_align |
| String | optional |
Format: block