Template:Multiple image/doc: Difference between revisions
Changed color in an example to clarify the difference between "background color =" and "footer_background =". Both colors had been #BBDD99, which made it impossible to determine the effect of "footer_background =". |
m update /doc + fix incorrect usage of semicolon per H:DL |
||
(37 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
||
{{High-use|demo={{ROOTPAGENAME}}}} |
|||
{{tsh|mim}} |
|||
{{Warning|1=Before making a gallery, please read over the '''[[WP:IG|image use policy for galleries]]'''. Generally, a gallery '''should not be added''' so long as there is space for images to be effectively presented adjacent to text. |
{{Warning|1=Before making a gallery, please read over the '''[[WP:IG|image use policy for galleries]]'''. Generally, a gallery '''should not be added''' so long as there is space for images to be effectively presented adjacent to text. |
||
}} |
}} |
||
Line 18: | Line 20: | ||
Note the different meanings of the ''width[n]'' parameters with vs. without automatic resizing. |
Note the different meanings of the ''width[n]'' parameters with vs. without automatic resizing. |
||
Please also note the option to set a ''total_width'' parameter at the beginning of the ''multiple image'' template. |
Please also note the option to set a ''total_width'' parameter at the beginning of the ''multiple image'' template. |
||
; |
;Automatic resizing of all images to the same height and to a given total width |
||
:<syntaxhighlight lang=" |
:<syntaxhighlight lang="wikitext"> |
||
{{Multiple image |
{{Multiple image|total_width = 600 |
||
<!-- Layout parameters --> |
<!-- Layout parameters --> |
||
| align = <!-- right (default), left, center, none --> |
| align = <!-- right (default), left, center, none --> |
||
| direction = <!-- horizontal (default), vertical --> |
| direction = <!-- horizontal (default), vertical --> |
||
| background color = <!-- box background as a 'hex triplet' web color |
| background color = <!-- box background as a 'hex triplet' web color prefixed by # e.g. #33CC00 --> |
||
| width = <!-- displayed width of each image in pixels (an integer, omit "px" suffix); overrides "width[n]"s below --> |
| width = <!-- displayed width of each image in pixels (an integer, omit "px" suffix); overrides "width[n]"s below --> |
||
| caption_align = <!-- left (default), center, right --> |
| caption_align = <!-- left (default), center, right --> |
||
Line 31: | Line 33: | ||
<!-- Header --> |
<!-- Header --> |
||
| header_background = <!-- header background as a 'hex triplet' web color |
| header_background = <!-- header background as a 'hex triplet' web color prefixed by # e.g. #33CC00 --> |
||
| header_align = <!-- center (default), left, right --> |
| header_align = <!-- center (default), left, right --> |
||
| header = <!-- header text --> |
| header = <!-- header text --> |
||
Line 49: | Line 51: | ||
| thumbtime2 = |
| thumbtime2 = |
||
| caption2 = |
| caption2 = |
||
<!-- and so on |
<!-- and so on --> |
||
<!-- Footer --> |
<!-- Footer --> |
||
| footer_background = <!-- footer background as a 'hex triplet' web color |
| footer_background = <!-- footer background as a 'hex triplet' web color prefixed by # e.g. #33CC00 --> |
||
| footer_align = <!-- left (default), center, right --> |
| footer_align = <!-- left (default), center, right --> |
||
| footer = <!-- footer text --> |
| footer = <!-- footer text --> |
||
Line 58: | Line 60: | ||
</syntaxhighlight> |
</syntaxhighlight> |
||
; |
;No automatic resizing of all images to the same height |
||
:<syntaxhighlight lang=" |
:<syntaxhighlight lang="wikitext"> |
||
{{multiple image |
{{multiple image |
||
<!-- Layout parameters --> |
<!-- Layout parameters --> |
||
Line 85: | Line 87: | ||
| thumbtime2 = |
| thumbtime2 = |
||
| caption2 = |
| caption2 = |
||
<!-- and so on |
<!-- and so on --> |
||
<!-- Footer --> |
<!-- Footer --> |
||
Line 101: | Line 103: | ||
| direction || horizontal ''(default)'', vertical |
| direction || horizontal ''(default)'', vertical |
||
|- |
|- |
||
| background color || To set [[List of colors|the background color]] of the box in which the images appear. |
| background color || To set [[List of colors|the background color]] of the box in which the images appear. |
||
|- |
|- |
||
| header_background || |
| header_background || |
||
Line 124: | Line 126: | ||
* If this parameter is omitted altogether, the image will link to its [[image description page]] as usual (<u>this is by far the most common usage case</u>). |
* If this parameter is omitted altogether, the image will link to its [[image description page]] as usual (<u>this is by far the most common usage case</u>). |
||
* If this parameter is present but left empty (i.e. {{mono|<nowiki>...|link1= |...</nowiki>}}), the image will not link to anything – this should be the case only for purely decorative images per [[WP:ALT]]. |
* If this parameter is present but left empty (i.e. {{mono|<nowiki>...|link1= |...</nowiki>}}), the image will not link to anything – this should be the case only for purely decorative images per [[WP:ALT]]. |
||
* '''Important:''' If the image is under a [[free license]] (such as the [[GNU Free Documentation License|GDFL]] or a free [[Creative Commons license|CC license]]), the terms of such license require the license, or a link to it, to be reproduced with the image. The image '''must''', therefore, link to its image description page, which can be achieved simply by omitting the link[n] parameter from the template as mentioned. Public domain and (theoretically) |
* '''Important:''' If the image is under a [[free license]] (such as the [[GNU Free Documentation License|GDFL]] or a free [[Creative Commons license|CC license]]), the terms of such license require the license, or a link to it, to be reproduced with the image. The image '''must''', therefore, link to its image description page, which can be achieved simply by omitting the link[n] parameter from the template as mentioned. Public domain and (theoretically) non-free use images are not subject to this restriction. |
||
|- |
|- |
||
| thumbtime''[n]'' || ''(as above)'' When using video 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]]. |
| thumbtime''[n]'' || ''(as above)'' When using video 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]]. |
||
Line 149: | Line 151: | ||
| footer = Players are cautioned with a yellow card and sent off with a red card. |
| footer = Players are cautioned with a yellow card and sent off with a red card. |
||
}} |
}} |
||
<syntaxhighlight lang="wikitext"> |
|||
<pre> |
|||
{{multiple image |
{{multiple image |
||
| width = 60 |
| width = 60 |
||
Line 158: | Line 160: | ||
| footer = Players are cautioned with a yellow card and sent off with a red card. |
| footer = Players are cautioned with a yellow card and sent off with a red card. |
||
}} |
}} |
||
</syntaxhighlight> |
|||
</pre> |
|||
{{clear}} |
{{clear}} |
||
{{multiple image |
{{multiple image |
||
Line 172: | Line 174: | ||
| caption2 = ...here overlaying a checkered background. |
| caption2 = ...here overlaying a checkered background. |
||
}} |
}} |
||
<syntaxhighlight lang="wikitext"> |
|||
<pre> |
|||
{{multiple image |
{{multiple image |
||
| align = left |
| align = left |
||
Line 185: | Line 187: | ||
| caption2 = ...here overlaying a checkered background. |
| caption2 = ...here overlaying a checkered background. |
||
}} |
}} |
||
</syntaxhighlight> |
|||
</pre> |
|||
{{clear}} |
{{clear}} |
||
{{multiple image |
{{multiple image |
||
Line 194: | Line 196: | ||
| 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. |
| 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. |
||
}} |
}} |
||
<syntaxhighlight lang="wikitext"> |
|||
<pre> |
|||
{{multiple image |
{{multiple image |
||
| width = 60 |
| width = 60 |
||
Line 202: | Line 204: | ||
| 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. |
| 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. |
||
}} |
}} |
||
</ |
</syntaxhighlight>{{clear right}} |
||
===With ''background color''=== |
===With ''background color''=== |
||
Line 217: | Line 219: | ||
| footer_background = #33CC00 |
| footer_background = #33CC00 |
||
| footer_align = center |
| footer_align = center |
||
| footer = [[Adoxa]] (''Adoxa moschatellina'') |
| footer = ''[[Adoxa]]'' (''Adoxa moschatellina'') |
||
}} |
}} |
||
{{clear}} |
{{clear}} |
||
<syntaxhighlight lang=" |
<syntaxhighlight lang="wikitext" style="overflow:auto;"> |
||
{{multiple image |
{{multiple image |
||
| background color = #BBDD99 |
| background color = #BBDD99 |
||
Line 232: | Line 234: | ||
| footer_background = #33CC00 |
| footer_background = #33CC00 |
||
| footer_align = center |
| footer_align = center |
||
| footer = [[Adoxa]] (''Adoxa moschatellina'') |
| footer = ''[[Adoxa]]'' (''Adoxa moschatellina'') |
||
}} |
|||
</syntaxhighlight> |
|||
{{clear}} |
|||
If the images have a clear background, this will by default be changed to white. To make the background color of the images match, set them with <code>image_style=background-color</code>. You might want to also remove the border. |
|||
{{multiple image |
|||
| align = center |
|||
| width = 64 |
|||
| background color = black |
|||
| image_style=background-color:black; border:none; |
|||
| image1 = Aries symbol (planetary color).svg|link1=Aries (astrology) |
|||
| image2 = Taurus symbol (planetary color).svg|link2=Taurus (astrology) |
|||
| image3 = Gemini symbol (planetary color).svg|link3=Gemini (astrology) |
|||
| image4 = Leo symbol (planetary color).svg|link4=Leo (astrology) |
|||
}} |
|||
{{clear}} |
|||
<syntaxhighlight lang="wikitext" style="overflow:auto;"> |
|||
{{multiple image |
|||
| align = center |
|||
| width = 64 |
|||
| background color = black |
|||
| image_style=background-color:black; border:none; |
|||
| image1 = Aries symbol (planetary color).svg|link1=Aries (astrology) |
|||
| image2 = Taurus symbol (planetary color).svg|link2=Taurus (astrology) |
|||
| image3 = Gemini symbol (planetary color).svg|link3=Gemini (astrology) |
|||
| image4 = Leo symbol (planetary color).svg|link4=Leo (astrology) |
|||
}} |
}} |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
Line 261: | Line 291: | ||
}} |
}} |
||
{{clear left}} |
{{clear left}} |
||
<syntaxhighlight lang=" |
<syntaxhighlight lang="wikitext" style="overflow:auto;"> |
||
{{multiple image |
{{multiple image |
||
| align = left |
| align = left |
||
Line 318: | Line 348: | ||
| footer = Both images have been rendered with the same height, and a total width of 320px |
| footer = Both images have been rendered with the same height, and a total width of 320px |
||
}} |
}} |
||
<syntaxhighlight lang="wikitext"> |
|||
<pre> |
|||
{{multiple image |
{{multiple image |
||
| align = right |
| align = right |
||
Line 333: | Line 363: | ||
| footer = Both images have been rendered with the same height, and a total width of 320px |
| footer = Both images have been rendered with the same height, and a total width of 320px |
||
}} |
}} |
||
</syntaxhighlight> |
|||
</pre> |
|||
{{clear}} |
|||
'''Using the <code>width[n]=</code> and <code>height[n]=</code> parameters.''' |
|||
{{multiple image |
|||
| align = right |
|||
| total_width = 480 |
|||
| image1 = Rainbow_trout.png |
|||
| caption1 = Square image of a trout, originally 300 x 300 pixels. |
|||
| image2 = Rainbow_trout.png |
|||
| width2 = 900 |
|||
| height2 = 900 |
|||
| caption2 = <code>width2</code> x <code>height2</code> = 900 x 900. |
|||
| image3 = Rainbow_trout.png |
|||
| width3 = 100 |
|||
| height3 = 200 |
|||
| caption3 = <code>width3</code> x <code>height3</code> = 100 x 200. |
|||
| image4 = Rainbow_trout.png |
|||
| width4 = 200 |
|||
| height4 = 100 |
|||
| caption4 = <code>width4</code> x <code>height4</code> = 200 x 100. |
|||
| footer = All images have been rendered with the same height except for image3, which is 100/200 = 1/2 the height of the other images. Image4 is 200/100 = 2 times the height of image1, so only its top half is visible. Total width set to 480px. |
|||
}} |
|||
<syntaxhighlight lang="wikitext"> |
|||
{{multiple image |
|||
| align = right |
|||
| total_width = 480 |
|||
| image1 = Rainbow_trout.png |
|||
| caption1 = Square image of a trout, originally 300 x 300 pixels. |
|||
| image2 = Rainbow_trout.png |
|||
| width2 = 900 |
|||
| height2 = 900 |
|||
| caption2 = <code>width2</code> x <code>height2</code> = 900 x 900. |
|||
| image3 = Rainbow_trout.png |
|||
| width3 = 100 |
|||
| height3 = 200 |
|||
| caption3 = <code>width3</code> x <code>height3</code> = 100 x 200. |
|||
| image4 = Rainbow_trout.png |
|||
| width4 = 200 |
|||
| height4 = 100 |
|||
| caption4 = <code>width4</code> x <code>height4</code> = 200 x 100. |
|||
| footer = All images have been rendered with the same height except for image3, which is 100/200 = 1/2 the height of the other images. Image4 is 200/100 = 2 times the height of image1, so only its top half is visible. Total width set to 480px. |
|||
}} |
|||
</syntaxhighlight> |
|||
{{clear}} |
{{clear}} |
||
The aspect ratio of each image is automatically retrieved from the File metadata. You can override the native width and height values by |
The aspect ratio of each image is automatically retrieved from the File metadata. You can override the native width and height values by |
||
Line 349: | Line 433: | ||
| image3 = DumpyLevel.jpg |
| image3 = DumpyLevel.jpg |
||
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.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 |
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, [[Real-time kinematic|RTK]] GPS Base station, Optical level. |
||
}} |
}} |
||
< |
<syntaxhighlight lang="wikitext" style="overflow:auto"> |
||
{{multiple image|perrow = 2|total_width=300 |
{{multiple image|perrow = 2|total_width=300 |
||
| image1 = Kern_Theodolit_DKM2-A.jpg |
| image1 = Kern_Theodolit_DKM2-A.jpg |
||
Line 357: | Line 441: | ||
| image3 = DumpyLevel.jpg |
| image3 = DumpyLevel.jpg |
||
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.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 |
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, [[Real-time kinematic|RTK]] GPS Base station, Optical level. |
||
}} |
}} |
||
</ |
</syntaxhighlight>{{clear right}} |
||
=== Removing the image border === |
=== Removing the image border === |
||
Line 376: | Line 460: | ||
| caption2 = Image of a trout |
| caption2 = Image of a trout |
||
}} |
}} |
||
< |
<syntaxhighlight lang="wikitext" style="overflow:auto"> |
||
{{multiple image |
{{multiple image |
||
| align = right |
| align = right |
||
Line 389: | Line 473: | ||
| alt2 = A trout |
| alt2 = A trout |
||
| caption2 = Image of a trout |
| caption2 = Image of a trout |
||
}}</ |
}}</syntaxhighlight>{{clear right}} |
||
=== Increasing the gap between images === |
=== Increasing the gap between images === |
||
Line 406: | Line 490: | ||
| caption2 = Image of a trout |
| caption2 = Image of a trout |
||
}} |
}} |
||
< |
<syntaxhighlight lang="wikitext" style="overflow:auto"> |
||
{{multiple image |
{{multiple image |
||
| align = right |
| align = right |
||
Line 419: | Line 503: | ||
| alt2 = A trout |
| alt2 = A trout |
||
| caption2 = Image of a trout |
| caption2 = Image of a trout |
||
}}</ |
}}</syntaxhighlight>{{clear right}} |
||
=== Directly invoking module === |
|||
==TemplateData== |
|||
On large pages, multiple uses of this template can contribute to the page exceeding the maximum [[WP:PEIS|post-expand include size]] limit. To reduce the include size, [[Module:Multiple image]] can be invoked directly as follows (note the extra "|" character after the module name): |
|||
{{#invoke:multiple image| |
|||
| width = 60 |
|||
| image1 = OOjs UI icon wikiTemplate.svg |
|||
| image2 = Cib-lua (CoreUI Icons v1.0.0).svg |
|||
}} |
|||
<syntaxhighlight lang="wikitext" style="overflow:auto"> |
|||
{{#invoke:multiple image| |
|||
| width = 60 |
|||
| image1 = OOjs UI icon wikiTemplate.svg |
|||
| image2 = Cib-lua (CoreUI Icons v1.0.0).svg |
|||
}}</syntaxhighlight>{{clear right}} |
|||
==TemplateData== |
|||
{{TemplateData header}} |
|||
<templatedata> |
<templatedata> |
||
{ |
{ |
||
"description": "This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box and each image.", |
"description": "This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box and each image.", |
||
"format": "{{_\n| _________________ = _\n}}\n", |
|||
"params": { |
"params": { |
||
"align": { |
"align": { |
||
Line 433: | Line 533: | ||
"description": "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.", |
"description": "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.", |
||
"example": "left/right/center/none", |
"example": "left/right/center/none", |
||
"suggestedvalues": [ |
|||
"left", |
|||
"center", |
|||
"right", |
|||
"none" |
|||
] |
|||
}, |
}, |
||
"direction": { |
"direction": { |
||
Line 447: | Line 547: | ||
"example": "horizontal/vertical", |
"example": "horizontal/vertical", |
||
"suggested": true, |
"suggested": true, |
||
"suggestedvalues": [ |
|||
"horizontal", |
|||
"vertical" |
|||
] |
|||
}, |
}, |
||
"total_width": { |
"total_width": { |
||
Line 482: | Line 582: | ||
"label": "Caption alignment", |
"label": "Caption alignment", |
||
"example": "left/right/center", |
"example": "left/right/center", |
||
"suggestedvalues": [ |
|||
"left", |
|||
"center", |
|||
"right" |
|||
] |
|||
}, |
}, |
||
"image1": { |
"image1": { |
||
Line 515: | Line 615: | ||
"link1": { |
"link1": { |
||
"type": "wiki-page-name", |
"type": "wiki-page-name", |
||
"description": "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) |
"description": "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) non-free use images are not subject to this restriction.", |
||
"label": "Link 1" |
"label": "Link 1" |
||
}, |
}, |
||
Line 535: | Line 635: | ||
"alt2": { |
"alt2": { |
||
"label": "Alt text 2", |
"label": "Alt text 2", |
||
"type": "line" |
"type": "line", |
||
"suggested": true |
|||
}, |
}, |
||
"caption2": { |
"caption2": { |
||
Line 574: | Line 675: | ||
"type": "string", |
"type": "string", |
||
"label": "Thumbtime 3" |
"label": "Thumbtime 3" |
||
}, |
|||
"image4": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 4" |
|||
}, |
|||
"width4": { |
|||
"type": "number", |
|||
"label": "Width 4" |
|||
}, |
|||
"alt4": { |
|||
"type": "line", |
|||
"label": "Alt text 4" |
|||
}, |
|||
"caption4": { |
|||
"label": "Caption 4", |
|||
"type": "content" |
|||
}, |
|||
"link4": { |
|||
"label": "Link 4", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime4": { |
|||
"type": "string", |
|||
"label": "Thumbtime 4" |
|||
}, |
|||
"image5": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 5" |
|||
}, |
|||
"width5": { |
|||
"type": "number", |
|||
"label": "Width 5" |
|||
}, |
|||
"alt5": { |
|||
"type": "line", |
|||
"label": "Alt text 5" |
|||
}, |
|||
"caption5": { |
|||
"label": "Caption 5", |
|||
"type": "content" |
|||
}, |
|||
"link5": { |
|||
"label": "Link 5", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime5": { |
|||
"type": "string", |
|||
"label": "Thumbtime 5" |
|||
}, |
|||
"image6": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 6" |
|||
}, |
|||
"width6": { |
|||
"type": "number", |
|||
"label": "Width 6" |
|||
}, |
|||
"alt6": { |
|||
"type": "line", |
|||
"label": "Alt text 6" |
|||
}, |
|||
"caption6": { |
|||
"label": "Caption 6", |
|||
"type": "content" |
|||
}, |
|||
"link6": { |
|||
"label": "Link 6", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime6": { |
|||
"type": "string", |
|||
"label": "Thumbtime 6" |
|||
}, |
|||
"image7": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 7" |
|||
}, |
|||
"width7": { |
|||
"type": "number", |
|||
"label": "Width 7" |
|||
}, |
|||
"alt7": { |
|||
"type": "line", |
|||
"label": "Alt text 7" |
|||
}, |
|||
"caption7": { |
|||
"label": "Caption 7", |
|||
"type": "content" |
|||
}, |
|||
"link7": { |
|||
"label": "Link 7", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime7": { |
|||
"type": "string", |
|||
"label": "Thumbtime 7" |
|||
}, |
|||
"image8": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 8" |
|||
}, |
|||
"width8": { |
|||
"type": "number", |
|||
"label": "Width 8" |
|||
}, |
|||
"alt8": { |
|||
"type": "line", |
|||
"label": "Alt text 8" |
|||
}, |
|||
"caption8": { |
|||
"label": "Caption 8", |
|||
"type": "content" |
|||
}, |
|||
"link8": { |
|||
"label": "Link 8", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime8": { |
|||
"type": "string", |
|||
"label": "Thumbtime 8" |
|||
}, |
|||
"image9": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 9" |
|||
}, |
|||
"width9": { |
|||
"type": "number", |
|||
"label": "Width 9" |
|||
}, |
|||
"alt9": { |
|||
"type": "line", |
|||
"label": "Alt text 9" |
|||
}, |
|||
"caption9": { |
|||
"label": "Caption 9", |
|||
"type": "content" |
|||
}, |
|||
"link9": { |
|||
"label": "Link 9", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime9": { |
|||
"type": "string", |
|||
"label": "Thumbtime 9" |
|||
}, |
|||
"image10": { |
|||
"type": "wiki-file-name", |
|||
"example": "example.jpg", |
|||
"label": "Image 10" |
|||
}, |
|||
"width10": { |
|||
"type": "number", |
|||
"label": "Width 10" |
|||
}, |
|||
"alt10": { |
|||
"type": "line", |
|||
"label": "Alt text 10" |
|||
}, |
|||
"caption10": { |
|||
"label": "Caption 10", |
|||
"type": "content" |
|||
}, |
|||
"link10": { |
|||
"label": "Link 10", |
|||
"type": "wiki-page-name" |
|||
}, |
|||
"thumbtime10": { |
|||
"type": "string", |
|||
"label": "Thumbtime 10" |
|||
}, |
}, |
||
"image_gap": { |
"image_gap": { |
||
Line 579: | Line 855: | ||
"label": "Image gap", |
"label": "Image gap", |
||
"description": "Override the distance between adjacent images. Integer width in pixels; no \"px\" suffix", |
"description": "Override the distance between adjacent images. Integer width in pixels; no \"px\" suffix", |
||
"example": "20" |
"example": "20", |
||
"default": "5" |
|||
}, |
}, |
||
"image_style": { |
"image_style": { |
||
Line 605: | Line 882: | ||
"footer": { |
"footer": { |
||
"type": "content", |
"type": "content", |
||
"label": "Footer" |
"label": "Footer", |
||
"description": "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." |
|||
}, |
}, |
||
"footer_background": { |
"footer_background": { |
||
Line 618: | Line 896: | ||
"label": "Footer alignment", |
"label": "Footer alignment", |
||
"example": "left/right/center", |
"example": "left/right/center", |
||
"suggestedvalues": [ |
|||
"left", |
|||
"center", |
|||
"right" |
|||
] |
|||
}, |
}, |
||
"border": { |
"border": { |
||
" |
"label": "Show or hide border", |
||
"description": "Use value \"infobox\" to hide the border when using the template within an infobox.", |
|||
"label": "Alignment within an Infobox" |
|||
"suggestedvalues": [ |
|||
"infobox" |
|||
] |
|||
} |
} |
||
} |
} |
||
"format": "block" |
|||
}</templatedata> |
}</templatedata> |
||
Line 645: | Line 925: | ||
* {{tl|Photomontage}} |
* {{tl|Photomontage}} |
||
* {{tl|Stack}} |
* {{tl|Stack}} |
||
* [[Wikipedia:Collage tips]] |
|||
<includeonly>{{Sandbox other| |
<includeonly>{{Sandbox other| |
||
Line 651: | Line 932: | ||
[[Category:Image formatting and function templates]] |
[[Category:Image formatting and function templates]] |
||
[[Category:Templates that add a tracking category]] |
[[Category:Templates that add a tracking category]] |
||
}}</includeonly> |
}}</includeonly> |
Revision as of 16:22, 18 June 2024
This is a documentation subpage for Template:Multiple image. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 56,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Before making a gallery, please read over the image use policy for galleries. Generally, a gallery should not be added so long as there is space for images to be effectively presented adjacent to text. |
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.
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
MOS:IMGSIZE states that a fixed width in pixels may only be specified, px
"... "which forces a fixed image width.""Where absolutely necessary."
)[a]
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. Please also note the option to set a total_width parameter at the beginning of the multiple image template.
- Automatic resizing of all images to the same height and to a given total width
{{Multiple image|total_width = 600 <!-- Layout parameters --> | align = <!-- right (default), left, center, none --> | direction = <!-- horizontal (default), vertical --> | background color = <!-- box background as a 'hex triplet' web color prefixed by # e.g. #33CC00 --> | width = <!-- displayed width of each image in pixels (an integer, omit "px" suffix); overrides "width[n]"s below --> | caption_align = <!-- left (default), center, right --> | image_style = <!-- border:1; (default) --> | image_gap = <!-- 5 (default)--> <!-- Header --> | header_background = <!-- header background as a 'hex triplet' web color prefixed by # e.g. #33CC00 --> | header_align = <!-- center (default), left, right --> | header = <!-- header text --> <!--image 1--> | image1 = <!-- filename only, i.e. without "File:" or "Image:" prefix --> | width1 = <!-- displayed width of image; overridden by "width" above --> | alt1 = | link1 = | thumbtime1 = | caption1 = <!--image 2--> | image2 = <!-- filename only, i.e. without "File:" or "Image:" prefix --> | width2 = <!-- displayed width of image; overridden by "width" above --> | alt2 = | link2 = | thumbtime2 = | caption2 = <!-- and so on --> <!-- Footer --> | footer_background = <!-- footer background as a 'hex triplet' web color prefixed by # e.g. #33CC00 --> | footer_align = <!-- left (default), center, right --> | footer = <!-- footer text --> }}
- No automatic resizing of all images to the same height
{{multiple image <!-- Layout parameters --> | align = <!-- right (default), left, center, none --> | direction = <!-- horizontal (default), vertical --> | background color = <!-- box background --> | total_width = <!-- total width of all the displayed images in pixels (an integer, omit "px" suffix) --> | caption_align = <!-- left (default), center, right --> <!-- Header --> | header_background = | header_align = <!-- center (default), left, right --> | header = <!--image 1--> | image1 = <!-- filename only, i.e. without "File:" or "Image:" prefix --> | alt1 = | link1 = | thumbtime1 = | caption1 = <!--image 2--> | image2 = <!-- filename only, i.e. without "File:" or "Image:" prefix --> | alt2 = | link2 = | thumbtime2 = | caption2 = <!-- and so on --> <!-- 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) The page linked to the [n]th image (i.e. the page that is loaded when the image is clicked).
|
thumbtime[n] | (as above) When using video 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
{{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.
}}
{{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
{{multiple image
| 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 = #33CC00
| footer_align = center
| footer = ''[[Adoxa]]'' (''Adoxa moschatellina'')
}}
If the images have a clear background, this will by default be changed to white. To make the background color of the images match, set them with image_style=background-color
. You might want to also remove the border.
{{multiple image
| align = center
| width = 64
| background color = black
| image_style=background-color:black; border:none;
| image1 = Aries symbol (planetary color).svg|link1=Aries (astrology)
| image2 = Taurus symbol (planetary color).svg|link2=Taurus (astrology)
| image3 = Gemini symbol (planetary color).svg|link3=Gemini (astrology)
| image4 = Leo symbol (planetary color).svg|link4=Leo (astrology)
}}
With links (link[n])
{{multiple image
| align = left
| image1 = Frecklesmule.jpg
| width1 = 143
| alt1 = A mule
| link1 = Mule
| caption1 = A mule<br />(骡子 ''luózi'')
| image2 = Donkey 1 arp 750px.jpg
| width2 = 150
| alt2 = A donkey
| link2 =
| caption2 = A donkey<br />(驴子 ''lǘzi'')
| image3 = Rainbow_trout.png
| width3 = 91
| alt3 = A trout
| caption3 = A fish<br />({{lang|zh|2=鱼}} ''yú'')
| 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
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).
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=
{{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
}}
Using the width[n]=
and height[n]=
parameters.
{{multiple image
| align = right
| total_width = 480
| image1 = Rainbow_trout.png
| caption1 = Square image of a trout, originally 300 x 300 pixels.
| image2 = Rainbow_trout.png
| width2 = 900
| height2 = 900
| caption2 = <code>width2</code> x <code>height2</code> = 900 x 900.
| image3 = Rainbow_trout.png
| width3 = 100
| height3 = 200
| caption3 = <code>width3</code> x <code>height3</code> = 100 x 200.
| image4 = Rainbow_trout.png
| width4 = 200
| height4 = 100
| caption4 = <code>width4</code> x <code>height4</code> = 200 x 100.
| footer = All images have been rendered with the same height except for image3, which is 100/200 = 1/2 the height of the other images. Image4 is 200/100 = 2 times the height of image1, so only its top half is visible. Total width set to 480px.
}}
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.
{{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, [[Real-time kinematic|RTK]] GPS Base station, Optical level.
}}
Removing the image border
The border around the images can be removed using |image_style=border:none
.
{{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).
{{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
}}
Directly invoking module
On large pages, multiple uses of this template can contribute to the page exceeding the maximum post-expand include size limit. To reduce the include size, Module:Multiple image can be invoked directly as follows (note the extra "|" character after the module name):
{{#invoke:multiple image|
| width = 60
| image1 = OOjs UI icon wikiTemplate.svg
| image2 = Cib-lua (CoreUI Icons v1.0.0).svg
}}
TemplateData
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 | Typ | 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 | optional |
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 | 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.
| 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 (see [[WP:ALT]]). 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 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) non-free 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 | no description
| File | suggested |
Width 2 | width2 | no description | Number | optional |
Alt text 2 | alt2 | no description | Line | suggested |
Caption 2 | caption2 | no description | Content | suggested |
Link 2 | link2 | no description | Page name | optional |
Thumbtime 2 | thumbtime2 | no description | String | optional |
Image 3 | image3 | no description
| File | optional |
Width 3 | width3 | no description | Number | optional |
Alt text 3 | alt3 | no description | Line | optional |
Caption 3 | caption3 | no description | Content | optional |
Link 3 | link3 | no description | Page name | optional |
Thumbtime 3 | thumbtime3 | no description | String | optional |
Image 4 | image4 | no description
| File | optional |
Width 4 | width4 | no description | Number | optional |
Alt text 4 | alt4 | no description | Line | optional |
Caption 4 | caption4 | no description | Content | optional |
Link 4 | link4 | no description | Page name | optional |
Thumbtime 4 | thumbtime4 | no description | String | optional |
Image 5 | image5 | no description
| File | optional |
Width 5 | width5 | no description | Number | optional |
Alt text 5 | alt5 | no description | Line | optional |
Caption 5 | caption5 | no description | Content | optional |
Link 5 | link5 | no description | Page name | optional |
Thumbtime 5 | thumbtime5 | no description | String | optional |
Image 6 | image6 | no description
| File | optional |
Width 6 | width6 | no description | Number | optional |
Alt text 6 | alt6 | no description | Line | optional |
Caption 6 | caption6 | no description | Content | optional |
Link 6 | link6 | no description | Page name | optional |
Thumbtime 6 | thumbtime6 | no description | String | optional |
Image 7 | image7 | no description
| File | optional |
Width 7 | width7 | no description | Number | optional |
Alt text 7 | alt7 | no description | Line | optional |
Caption 7 | caption7 | no description | Content | optional |
Link 7 | link7 | no description | Page name | optional |
Thumbtime 7 | thumbtime7 | no description | String | optional |
Image 8 | image8 | no description
| File | optional |
Width 8 | width8 | no description | Number | optional |
Alt text 8 | alt8 | no description | Line | optional |
Caption 8 | caption8 | no description | Content | optional |
Link 8 | link8 | no description | Page name | optional |
Thumbtime 8 | thumbtime8 | no description | String | optional |
Image 9 | image9 | no description
| File | optional |
Width 9 | width9 | no description | Number | optional |
Alt text 9 | alt9 | no description | Line | optional |
Caption 9 | caption9 | no description | Content | optional |
Link 9 | link9 | no description | Page name | optional |
Thumbtime 9 | thumbtime9 | no description | String | optional |
Image 10 | image10 | no description
| File | optional |
Width 10 | width10 | no description | Number | optional |
Alt text 10 | alt10 | no description | Line | optional |
Caption 10 | caption10 | no description | Content | optional |
Link 10 | link10 | no description | Page name | optional |
Thumbtime 10 | thumbtime10 | no description | String | optional |
Image gap | image_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 | no description
| String | optional |
Footer | 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. | 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 | no description
| String | optional |
Show or hide border | border | Use value "infobox" to hide the border when using the template within an infobox.
| Unknown | optional |
Tracking categories
- Category:Pages using multiple image with auto scaled images (20,840)
- Category:Pages using multiple image with manual scaled images (1,561)
Notes
- ^ The |upright= parameter can only be used to relatively-size an image when using the |thumb= parameter, and this template needs to format images without thumbs, so it has no easy way to access the Wikimedia relative-sizing machinery.
See also
- {{Gallery}}
- {{Image array}}
- {{Image frame}}
- {{Photomontage}}
- {{Stack}}
- Wikipedia:Collage tips