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 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.
Syntax and parameters
[edit]- No automatic resizing of all images to the same height
{{multiple image|caption_align=center
<!-- Essential parameters -->
| align = <!-- right (default), left, center, none -->
| direction = <!-- horizontal (default), vertical -->
| background color = <!-- box background -->
<!-- Header -->
| header_background =
| header_align = <!-- center (default), left, right -->
| header =
<!-- Images -->
| width = <!-- displayed width of each image in pixels (an integer, omit "px" suffix); overrides "width[n]"s below -->
<!--image 1-->
| image1 = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
| width1 = <!-- displayed width of image; overridden by "width" above -->
| alt1 =
| link1 =
| caption1 =
<!--image 2-->
| image2 = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
| width2 = <!-- displayed width of image; overridden by "width" above -->
| alt2 =
| link2 =
| caption2 =
<!-- and so on, to a maximum of 10 images (image10) -->
<!-- Footer -->
| footer_background =
| footer_align = <!-- left (default), center, right -->
| footer =
}}
- Automatic resizing of all images to the same height and to a given total width
{{multiple image|caption_align=center
<!-- Essential parameters -->
| align = <!-- right (default), left, center, none -->
| direction = <!-- horizontal (default), vertical -->
| background color = <!-- box background -->
<!-- Header -->
| header_background =
| header_align = <!-- center (default), left, right -->
| header =
<!-- Images -->
| total_width = <!-- total width of all the displayed images in pixels (an integer, omit "px" suffix) -->
<!--image 1-->
| image1 = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
| width1 = <!-- full width of the ORIGINAL UNSCALED image -->
| height1 = <!-- full height of the ORIGINAL UNSCALED image -->
| alt1 =
| link1 =
| caption1 =
<!--image 2-->
| image2 = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
| width2 = <!-- full width of the ORIGINAL UNSCALED image -->
| height2 = <!-- full height of the ORIGINAL UNSCALED image -->
| alt2 =
| link2 =
| caption2 =
<!-- and so on, to a maximum of 10 images (image10) -->
<!-- Footer -->
| footer_background =
| footer_align = <!-- left (default), center, right -->
| footer =
}}
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. |
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. |
Examples
[edit]{{multiple image|caption_align=center|header_align=center
| 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.
}}
{{multiple image|caption_align=center|header_align=center
| 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|caption_align=center|header_align=center
| 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
[edit]{{multiple image|caption_align=center|header_align=center
| background color = #BBDD99
| width = 160
| image1 = Adoxa_moschatellina_210406.jpg
| alt1 = Green herb with a few tiny yellow-white flowers
| image2 = Adoxa_moschatellina_210406a.jpg
| alt2 = Three small white and yellow flowers before green-leaf background
| image3 = adoxa_moschatellina_blatt.jpeg
| alt3 = Leaves of a plant, in groups of three each with three lobes
| footer_background = #BBDD99
| footer_align = center
| footer = [[Adoxa]] (''Adoxa moschatellina'')
}}
with links (link[n])
[edit]{{multiple image|caption_align=center|header_align=center
| align = left
| image1 = Frecklesmule.jpg
| width1 = 143
| alt1 = A mule
| link1 = Mule
| caption1 = A mule<br />(骡子 ''luózi'')
| image2 = Donkey in Clovelly, North Devon, England.jpg
| width2 = 150
| alt2 = A donkey
| link2 =
| caption2 = A donkey<br />(驴子 ''lǘzi'')</center>
| image3 = Rainbow_trout.png
| width3 = 91
| alt3 = A trout
| caption3 = A fish<br />({{lang|zh|2=鱼}} ''yú'')</center>
| footer = 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 [[Image description page|standard image description page]].
}}
using direction
[edit]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).
to match image heights
[edit]- 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 image|caption_align=center|header_align=center
| align = right
| total_width = 320
| image1 = Donkey in Clovelly, North Devon, England.jpg
| width1 = 750 | height1 = 536
| alt1 = A donkey
| caption1 = Rectangular image of a donkey, originally 536 pixels high.
| image2 = Rainbow_trout.png
| width2 = 300 | height2 = 300
| 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
}}
Multiple rows
[edit]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.
{{multiple image|perrow = 2|total_width=300
| image1 = Kern_Theodolit_DKM2-A.jpg |width1=319|height1=425
| image2 = Total-Robotic-Station.jpg |width2=1728|height2=3072
| image3 = DumpyLevel.jpg |width3=1600|height3=1200
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.jpg|width4=427|height4=640
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, [[Real-time kinematic | RTK]] GPS Base station.
}}
TemplateData
[edit]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.
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 |
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
| String | suggested |
Background color | background color | Defines the background color between the border of the box and the images. | String | optional |
Header | header | no description | String | optional |
Footer | footer | no description | String | optional |
Caption alignment | caption_align | no description
| String | optional |
Header alignment | header_align | no description
| String | optional |
Footer alignment | footer_align | no description
| String | optional |
Header background | header_background | no description | String | optional |
Footer background | footer_background | no description | 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.
| String | suggested |
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 (see [[WP:ALT]]). Similarly for Alt text 2, etc. | String | optional |
Caption 1 | caption1 | Caption 1 is caption of first image. Similarly for Caption 2, etc. | String | 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. | String | optional |
Image 2 | image2 | no description
| String | suggested |
Width 2 | width2 | no description | String | optional |
Alt text 2 | alt2 | no description | String | optional |
Caption 2 | caption2 | no description | String | suggested |
Link 2 | link2 | no description | String | optional |
Image 3 | image3 | no description
| String | optional |
Width 3 | width3 | no description | String | optional |
Alt text 3 | alt3 | no description | String | optional |
Caption 3 | caption3 | no description | String | optional |
Link 3 | link3 | no description | String | optional |