Editing Template:Multiple image/doc (section)

==Syntax and parameters==
Provide {{para|height[n]}} and {{para|total_width}} parameters to obtain automatic resizing.
Note the different meanings of the {{para|width[n]}} parameters with vs. without automatic resizing.
Please also note the option to set a {{para|total_width}} parameter at the beginning of the {{tlf|multiple image}} template.
;Automatic resizing of all images to the same height and to a given total width
:<syntaxhighlight lang="wikitext">
{{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         = <!-- 1 (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 -->
| class1            = <!-- CSS class. Darkmode theme options: skin-invert-image / bg-transparent -->
| 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 -->
| class2            = <!-- CSS class. Darkmode theme options: skin-invert-image / bg-transparent -->
| 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 -->
}}
</syntaxhighlight>

;No automatic resizing of all images to the same height
:<syntaxhighlight lang="wikitext">
{{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 -->
 | class1            = <!-- CSS class. Darkmode theme options: skin-invert-image / bg-transparent -->
 | alt1              = 
 | link1             = 
 | thumbtime1        =
 | caption1          = 
<!--image 2-->
 | image2            = <!-- filename only, i.e. without "File:" or "Image:" prefix -->
 | class2            = <!-- CSS class. Darkmode theme options: skin-invert-image / bg-transparent -->
 | alt2              = 
 | link2             = 
 | thumbtime2        =
 | caption2          = 
<!-- and so on -->

<!-- Footer -->
 | footer_background = 
 | footer_align      = <!-- left (default), center, right -->
 | footer            = 
}}
</syntaxhighlight>

{| class=wikitable
! Parameter !! Description
|-
| align          || right ''(default)'', left, center
|-
| direction      || horizontal ''(default)'', vertical
|-
| background_color || To set [[List of colors|the background color]] of the box in which the images appear. 
|-
| text_color || To set caption text color. Useful for when using darker background colors.
|-
| header_background || 
|-
| header_align   || center ''(default)'', left, right
|-
| header         || 
|-
| width          || Use to set the same width for each image (i.e. overrides any {{mono|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 {{mono|total_width}} and {{mono|width}}.
|-
| image''[n]''   || (where ''[n]'' = 1 to 10)&nbsp; Filename of [n]th image.
|-
| width''[n]''   || ''(as above)''&nbsp; Two meanings: (1) The width (in pixels, integer, omit "px") of [n]th image. Overridden by {{mono|width}} (if set). (2) The full width of the original [n]th image if {{mono|total_width}} is given in order to resize all images to the same height and a given total width.
|-
| height''[n]''   || ''(as above)''&nbsp; The full height of the original [n]th image if {{mono|total_width}} is given in order to resize all images to the same height and a given total width. Ignored otherwise.
|-
| class''[n]''   || ''(as above)''&nbsp; CSS class for the image. Useful for [[Wikipedia:Dark mode|darkmode theme]] options: skin-invert-image or bg-transparent
|-
| alt''[n]''     || ''(as above)''&nbsp; [[WP:ALT|Alt description]] for [n]th image.
|-
| link''[n]''    || ''(as above)''&nbsp; The page linked to the [n]th image (i.e. the page that is loaded when the image is clicked).
* 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]].
* '''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)''&nbsp; 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)''&nbsp; 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 [[#Using direction|display the images vertically]].
|}