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 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. (Wikipedia:Image use policy states: "Except with very good reason, do not use
)
px"... "which forces a fixed image width. In most cases upright=scaling factor 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
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.
- No automatic resizing of all images to the same height
- <source lang="xml">
</source>
- Automatic resizing of all images to the same height and to a given total width
- <source lang="xml">
</source>
| Parameter | Description |
|---|---|
| align | right (default), left, center |
| direction | horizontal (default), vertical |
| background color | To set the background color of the box in which the images appear. |
| header_background | |
| header_align | center (default), left, right |
| header | |
| width | Use to set the same width for each image (i.e. overrides any width[n] below). Do not include if different image widths intended, including if images are to be resized to a fixed total width. |
| total_width | Use to scale the images to the same height and this total width. Do not use both total_width and width. |
| image[n] | (where [n] = 1 to 10) Filename of [n]th image. |
| width[n] | (as above) Two meanings: (1) The width (in pixels, integer, omit "px") of [n]th image. Overridden by width (if set). (2) The full width of the original [n]th image if total_width is given in order to resize all images to the same height and a given total width. |
| height[n] | (as above) The full height of the original [n]th image if total_width is given in order to resize all images to the same height and a given total width. Ignored otherwise. |
| alt[n] | (as above) Alt description for [n]th image. |
| link[n] | (as above) To specify the page to which the [n]th image is linked (i.e. the page that is loaded when the image is clicked). If set as empty (e.g. ...|alt1=... |link1= |caption1=...), linking is disabled (even to the standard Wikipedia image description page); consider WP:ALT. Note: This parameter must not be used with images that have been given free licenses (such as the GDFL or a free CC license) as these licenses require images to be linked to a declaration of the license under which they are being used. |
| thumbtime[n] | (as above) When using Ogg Theora files, sets the time within the video that is used for the initial display. This is either a number of seconds or hours:minutes:seconds; see commons:Commons:Video#Setting a video thumbnail image. |
| caption[n] | (as above) Caption for the [n]th image. |
| caption_align | left (default), center, right |
| footer_background | |
| footer_align | left (default), center, right |
| footer | 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. |
Examples
Players are cautioned with a yellow card and sent off with a red card.
{{multiple image
| width = 60
| image1 = Yellow card.svg
| alt1 = Yellow cartouche
| image2 = Red card.svg
| alt2 = Red cartouche
| footer = Players are cautioned with a yellow card and sent off with a red card.
}}
PNG transparency demonstration
A PNG image with an 8-bit transparency layer...
...here overlaying a checkered background.
{{multiple image
| align = left
| direction = vertical
| width = 200
| header = [[Portable Network Graphics|PNG]] transparency demonstration
| image1 = PNG transparency demonstration 1.png
| alt1 = Colored dice with white background
| caption1 = A PNG image with an 8-bit transparency layer...
| image2 = PNG transparency demonstration 2.png
| alt2 = Colored dice with checkered background
| caption2 = ...here overlaying a checkered background.
}}
{{multiple image
| width = 60
| image1=Ribbon numeral 2.png | alt1=2
| image2=Ribbon numeral 3.png | alt2=3
| image3=Ribbon numeral 4.png | alt3=4
| footer = When a user has many of one type of [[WP:BARN|barnstar]], they can represent them with [[WP:RIBBON|ribbons]] and these numerals to indicate the count.
}}
With background color
Adoxa (Adoxa moschatellina)
<source lang="moin" style="overflow:auto;">
Adoxa (Adoxa moschatellina)
</source>
With links (link[n])
A mule
(骡子 luózi)
(骡子 luózi)
(驴子 lǘzi)
(鱼 yú)
The image of the mule links to Mule; the image of the donkey does not link anywhere; the image of the trout links to a standard image description page.
<source lang="moin" style="overflow:auto;">
A mule
(骡子 luózi)
(骡子 luózi)
(驴子 lǘzi)
(鱼 yú)
The image of the mule links to Mule; the image of the donkey does not link anywhere; the image of the trout links to a standard image description page.
</source>
Using direction
By default, the images the template presents are displayed horizontally, as a row (see left; equivalent to setting |direction=horizontal). To display them vertically, i.e. as a column, set |direction=vertical (see right).
(horizontal)
(vertical)
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=
Rectangular image of a donkey, originally 536 pixels high.
Square image of a trout, originally 300 pixels high.
Both images have been rendered with the same height, and a total width of 320px
{{multiple image
| align = right
| total_width = 320
| image1 = Donkey 1 arp 750px.jpg
| alt1 = A donkey
| caption1 = Rectangular image of a donkey, originally 536 pixels high.
| image2 = Rainbow_trout.png
| alt2 = A trout
| caption2 = Square image of a trout, originally 300 pixels high.
| footer = Both images have been rendered with the same height, and a total width of 320px
}}
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.
Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, RTK GPS Base station.
{{multiple image|perrow = 2|total_width=300
| image1 = Kern_Theodolit_DKM2-A.jpg
| image2 = Total-Robotic-Station.jpg
| image3 = DumpyLevel.jpg
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.jpg
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, [[Real-time kinematic | RTK]] GPS Base station.
}}
Removing the image border
The border around the images can be removed using |image_style=border:none.
Image of a donkey
Image of a trout
{{multiple image
| align = right
| total_width = 320
| image_style = border:none;
| image1 = Donkey 1 arp 750px.jpg
| alt1 = A donkey
| caption1 = Image of a donkey
| image2 = Rainbow_trout.png
| alt2 = A trout
| caption2 = Image of a trout
}}
Increasing the gap between images
The gap between the images can be increased using |image_gap=N, where N is the number of pixels (must be non-negative).
Image of a donkey
Image of a trout
{{multiple image
| align = right
| total_width = 320
| image_gap = 20
| image1 = Donkey 1 arp 750px.jpg
| alt1 = A donkey
| caption1 = Image of a donkey
| image2 = Rainbow_trout.png
| alt2 = A trout
| caption2 = Image of a trout
}}
TemplateData
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/or for each images.
| ⧼templatedata-doc-param-name⧽ | ⧼templatedata-doc-param-desc⧽ | ⧼templatedata-doc-param-type⧽ | ⧼templatedata-doc-param-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.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Direction | direction | Direction in which to tile the images.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| 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
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Background color | background color | Defines the background color between the border of the box and the images. | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Caption alignment | caption_align |
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Header background | header_background | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Header alignment | header_align |
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Header | header | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Image 1 | image1 | Image 1 is name of first image. Similarly for Image 2, etc. File name only; no "File:" or "Image:" prefix.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Width 1 | width1 | width 1 is width of first image. Similarly for Width 2, etc. | ⧼templatedata-doc-param-type-number⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Alt text 1 | alt1 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Caption 1 | caption1 | Caption 1 is caption of first image. Similarly for Caption 2, etc. | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-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 as per WP:ALT. 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. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-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. | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Image 2 | image2 |
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Width 2 | width2 | ⧼templatedata-doc-param-type-number⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Alt text 2 | alt2 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Caption 2 | caption2 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ | |
| Link 2 | link2 | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Thumbtime 2 | thumbtime2 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Image 3 | image3 |
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Width 3 | width3 | ⧼templatedata-doc-param-type-number⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Alt text 3 | alt3 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Caption 3 | caption3 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Link 3 | link3 | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Thumbtime 3 | thumbtime3 | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Footer background | footer_background | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| Footer alignment | footer_align |
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Footer | footer | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
Format: block
Tracking categories
- Category:Pages using multiple image with auto scaled images (210)
- Category:Pages using multiple image with manual scaled images (9)
See also
- {{Gallery}}
- {{Image array}}
- {{Image frame}}
- {{Photomontage}}