View source for Template:Multiple image/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. -->

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 ==
{{TemplateDataHeader}}
<templatedata>
{
    "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": {}
    }
}
</templatedata>

* '''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]].<br />'''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.
* '''background color''' defines the [[List of colors|background color]] between the border of the box and the images.
* header, footer, background color and captions are optional.

<pre style="width: 85%; overflow:auto">
{{multiple image
<!-- Essential parameters -->
| align     = <!-- left/right/center/none --> 
| direction = <!-- horizontal/vertical -->
| width     = <!-- integer width in pixels; no "px" suffix -->

<!-- Image 1 -->
| image1    = <!-- file name only; no "File:" or "Image:" prefix -->
| width1    = 
| alt1      = 
| caption1  = 

<!-- Image 2 -->
| image2    = <!-- file name only; no "File:" or "Image:" prefix -->
| width2    = 
| alt2      = 
| caption2  = 

<!-- Image 3 -->
| image3    = <!-- file name only; no "File:" or "Image:" prefix -->
| width3    = 
| alt3      = 
| caption3  =

<!-- up to |image10 is accepted -->

<!-- Extra parameters -->
| header            = 
| header_align      = <!-- left/right/center -->
| header_background = 
| footer            = 
| footer_align      = <!-- left/right/center -->
| footer_background = 
| background color  = 
}}</pre>

== Examples ==
{{multiple image
| footer    = Players are cautioned with a yellow card and sent off with a red card.
| width     = 60

| image1    = Yellow card.svg
| alt1      = Yellow cartouche

| image2    = Red card.svg
| alt2      = Red cartouche
}}

<pre style="overflow: auto;">
{{multiple image
| footer    = Players are cautioned with a yellow card and sent off with a red card.
| width     = 60

| image1    = Yellow card.svg
| alt1      = Yellow cartouche

| image2    = Red card.svg
| alt2      = Red cartouche
}}</pre>
{{-}}

{{multiple image
| align     = left
| direction = vertical
| header    = [[PNG]] transparency demonstration
| width     = 200

| 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 overlaid onto a checkered background.
}}

<pre style="overflow: auto;">
{{multiple image
| align     = left
| direction = vertical
| header    = [[PNG]] transparency demonstration
| width     = 200

| 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 overlaid onto a checkered background.
}}</pre>
{{-}}

{{multiple image
| 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.
| width    = 60

| image1   = Ribbon numeral 2.png
| alt1     = 2

| image2   = Ribbon numeral 3.png
| alt2     = 3

| image3   = Ribbon numeral 4.png
| alt3     = 4
}}

<pre style="overflow: auto;">
{{multiple image
| 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.
| width    = 60

| image1   = Ribbon numeral 2.png
| alt1     = 2

| image2   = Ribbon numeral 3.png
| alt2     = 3

| image3   = Ribbon numeral 4.png
| alt3     = 4
}}</pre>
{{-}}

=== Example with background color ===
{{multiple image
| 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. They are in groups of three, each with three lobes.

| footer=[[Adoxa]] (''Adoxa moschatellina'')
| footer_background=#BBDD99
| background color=#BBDD99
| footer_align=center
| width=160
}}

<pre style="overflow: auto;">
{{multiple image
| 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. They are in groups of three, each with three lobes.

| footer=[[Adoxa]] (''Adoxa moschatellina'')
| footer_background=#BBDD99
| background color=#BBDD99
| footer_align=center
| width=160
}}
</pre>
{{-}}

=== Example with links ===
{{multiple image
| footer    = The mule links to ''[[Mule]]'', the donkey does not link anywhere, and the trout links to its image description page as usual.
| align     = left

| image1    = Frecklesmule.jpg
| width1    = 143
| alt1      = A mule
| caption1  = <center>A mule<br />骡子, ''luózi''</center>
| link1     = Mule

| image2    = Donkey 1 arp 750px.jpg
| width2    = 150
| alt2      = A donkey
| caption2  = <center>A donkey<br />驴子, lǘzi</center>
| link2     =

| image3    = Rainbow_trout.png
| width3    = 91
| alt3      = A trout
| caption3  = <center>A fish<br />
{{lang|zh|2=鱼}}, ''yú''</center>
}}

<pre style="overflow: auto;">
{{multiple image
| footer    = The mule links to ''[[Mule]]'', the donkey does not link anywhere, and the trout links to its image description page as usual.
| align     = left

| image1    = Frecklesmule.jpg
| width1    = 143
| alt1      = A mule
| caption1  = <center>A mule<br />骡子, ''luózi''</center>
| link1     = Mule

| image2    = Donkey 1 arp 750px.jpg
| width2    = 150
| alt2      = A donkey
| caption2  = <center>A donkey<br />驴子, lǘzi</center>
| link2     =

| image3    = Rainbow_trout.png
| width3    = 91
| alt3      = A trout
| caption3  = <center>A fish<br />
{{lang|zh|2=鱼}}, ''yú''</center>
}}
</pre>
{{-}}

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

{{multiple image
| align     = left
| direction = vertical
| header    = vertical
| width     = 60
| image1    = Ribbon numeral 2.png
| image2    = Ribbon numeral 3.png
| image3    = Ribbon numeral 4.png
}}

{{multiple image
| align     = right
| direction = horizontal
| header    = horizontal
| width     = 60
| image1    = Ribbon numeral 2.png
| image2    = Ribbon numeral 3.png
| image3    = Ribbon numeral 4.png
}}
{{clear}}

==== Matching image heights ====
: ''This trick is not required if all images have the same [[Aspect ratio (image)|aspect ratio]], where ''{{para|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 {{para|width''n''}} parameters, of the form:
** <code><nowiki>
{{#expr:</nowiki> (''dh'' * ''ow'' / ''oh'') round 0<nowiki>}}</nowiki></code>
* 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 {{para|width''n''}} to be the desired height. If all are square, only {{para|width}} needs to be set.

{{multiple image
| footer    = The two images are both rendered 100 pixels high
| align     = right

| image1    = Donkey 1 arp 750px.jpg
| width1    = {{#expr: (100 * 750 / 536) round 0}}
| alt1      = A donkey
| caption1  = A donkey, not square and originally 536 pixels high

| image2    = Rainbow_trout.png
| width2    = 100
| alt2      = A trout
| caption2  = A fish, square and originally 300 pixels high
}}

<pre style="overflow: auto;">
{{multiple image
| footer    = The two images are both rendered 100 pixels high
| align     = right

| image1    = Donkey 1 arp 750px.jpg
| width1    = {{#expr: (100 * 750 / 536) round 0}}
| alt1      = A donkey
| caption1  = A donkey, not square and originally 536 pixels high

| image2    = Rainbow_trout.png
| width2    = 100
| alt2      = A trout
| caption2  = A fish, square and originally 300 pixels high
}}
</pre>
{{clear}}

<includeonly><!--
++++ PLEASE ADD CATEGORIES BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
</includeonly>