Template:Multiple image/doc - Revision history

Casiope: /* Syntax */

2020-07-20T17:20:26Z

Syntax

← Older revision		Revision as of 17:20, 20 July 2020
Line 7:		Line 7:
	== Syntax ==		== Syntax ==

	Provide {{para\|height[n]}} and {{para\|total_width}} parameters to obtain automatic resizing.		Provide {{para\|height{{var\|[n]}}}} and {{para\|total_width}} parameters to obtain automatic resizing.
	Note the different meanings of the {{para\|width[n]}} parameters with versus without automatic resizing.		Note the different meanings of the {{para\|width{{var\|[n]}}}} parameters with versus without automatic resizing.
	Please also note the option to set a {{para\|total_width}} parameter at the beginning of the template:multiple image.		Please also note the option to set a {{para\|total_width}} parameter at the beginning of the template:multiple image.

Casiope: /* Parameters */

2020-07-13T18:52:25Z

Parameters

← Older revision		Revision as of 18:52, 13 July 2020
Line 95:		Line 95:
	== Parameters ==		== Parameters ==

	; align : ~~right~~ (default), center, or left		; {{para\|align}} : Right (default), center, or left.
	; direction : ~~horizontal~~ (default) or vertical		; {{para\|direction}} : Horizontal (default) or vertical.
	; background color : To set the background color of the box in which the images appear.		; {{para\|background color}} : To set the background color of the box in which the images appear.
	; header_background :		; {{para\|header_background}} :
	; header_align : ~~center~~ (default), left, or right		; {{para\|header_align}} : Center (default), left, or right.
	; header :		; {{para\|header}} :
	; width : Use to set the same width for each image (i.e. overrides any {{para\|width{{var\|[n]}}}} below). Do not include if different image widths intended, including if images are to be resized to a fixed total width.		; {{para\|width}} : Use to set the same width for each image (i.e. overrides any {{para\|width{{var\|[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 {{para\|total_width}} and {{para\|width}}.		; {{para\|total_width}} : Use to scale the images to the same height and this total width. Do not use both {{para\|total_width}} and {{para\|width}}.
	; image{{var\|[n]}} : (where {{var\|[n]}} = 1 to 10) Filename of [n]th image.		; {{para\|image{{var\|[n]}}}} : (where {{var\|[n]}} = 1 to 10) Filename of [n]th image.
	; width{{var\|[n]}} : As above. Two meanings:		; {{para\|width{{var\|[n]}}}} : As above. Two meanings:
	:# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para\|width}} if set.		:# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para\|width}} if set.
	:# The full width of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width.		:# The full width of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width.
	; height{{var\|[n]}} : As above. The full height of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width. Ignored otherwise.		; {{para\|height{{var\|[n]}}}} : As above. The full height of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width. Ignored otherwise.
	; alt{{var\|[n]}} : As above. Alt description for [n]th image.		; {{para\|alt{{var\|[n]}}}} : As above. Alt description for [n]th image.
	; link{{var\|[n]}} : As above. The page linked to the [n]th image (i.e. the page that is loaded when the image is clicked).		; {{para\|link{{var\|[n]}}}} : As above. 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.		:* If this parameter is omitted altogether, the image will link to its image description page as usual.
	* If this parameter is present but left empty (i.e. <code><nowiki>...\|link1= \|...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.		:* If this parameter is present but left empty (i.e. <code><nowiki>...\|link1= \|...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.
	; thumbtime{{var\|[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.		; {{para\|thumbtime{{var\|[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.
	; caption{{var\|[n]}} : As above. Caption for the [n]th image.		; {{para\|caption{{var\|[n]}}}} : As above. Caption for the [n]th image.
	; caption_align : ~~left~~ (default), center, or right		; {{para\|caption_align}} : Left (default), center, or right.
	; footer_background :		; {{para\|footer_background}} :
	; footer_align : ~~left~~ (default), center, or right		; {{para\|footer_align}} : Left (default), center, or 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.		; {{para\|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 ==		== Examples ==

Casiope: /* Syntax and parameters */

2020-07-13T17:47:14Z

Syntax and parameters

← Older revision		Revision as of 17:47, 13 July 2020
Line 5:		Line 5:
	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.		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~~ ==		== Syntax ==

	Provide {{para\|height[n]}} and {{para\|total_width}} parameters to obtain automatic resizing.		Provide {{para\|height[n]}} and {{para\|total_width}} parameters to obtain automatic resizing.
Line 93:		Line 93:
	</syntaxhighlight>		</syntaxhighlight>

	~~{\| class~~=~~wikitable~~		== Parameters ==
	~~! Parameter~~
	~~! Description~~		; align : right (default), center, or left
	\|-		; direction : horizontal (default) or vertical
	\| align		; background color : To set the background color of the box in which the images appear.
	\| right (default), left~~, center~~		; header_background :
	\|-		; header_align : center (default), left, or right
	\| direction		; header :
	\| horizontal (default), vertical		; width : Use to set the same width for each image (i.e. overrides any {{para\|width{{var\|[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 {{para\|total_width}} and {{para\|width}}.
	\| background color		; image{{var\|[n]}} : (where {{var\|[n]}} = 1 to 10) Filename of [n]th image.
	\| To set the background color of the box in which the images appear.		; width{{var\|[n]}} : As above. Two meanings:
	\|-		:# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para\|width}} if set.
	\| header_background		:# The full width of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width.
	\|		; height{{var\|[n]}} : As above. The full height of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width. Ignored otherwise.
	\|-		; alt{{var\|[n]}} : As above. Alt description for [n]th image.
	\| header_align		; link{{var\|[n]}} : As above. The page linked to the [n]th image (i.e. the page that is loaded when the image is clicked).
	\| center (default), left, right
	\|-
	\|header
	\|
	\|-
	\| width
	\| Use to set the same width for each image (i.e. overrides any {{para\|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 {{para\|total_width}} and {{para\|width}}.
	\|-
	~~\| image''~~[n]''
	\| (where ''[n]'' = 1 to 10) Filename of [n]th image.
	\|-
	~~\| width''~~[n]''
	\| As above. Two meanings:
	# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para\|width}} if set.
	# The full width of the original [n]th image if {{para\|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 {{para\|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).
	* If this parameter is omitted altogether, the image will link to its image description page as usual.		* If this parameter is omitted altogether, the image will link to its image description page as usual.
	* If this parameter is present but left empty (i.e. <code><nowiki>...\|link1= \|...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.		* If this parameter is present but left empty (i.e. <code><nowiki>...\|link1= \|...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.
	\|-		; thumbtime{{var\|[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.
	~~\| thumbtime''~~[n]''		; caption{{var\|[n]}} : As above. Caption for the [n]th image.
	\| 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.		; caption_align : left (default), center, or right
	\|-		; footer_background :
	~~\| caption''~~[n]''		; footer_align : left (default), center, or right
	\| As above. Caption for the [n]th image.		; 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.
	\|-
	\| 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 ==		== Examples ==

Casiope: Created page with "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 appro..."

2020-07-10T17:37:24Z

Created page with "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 appro..."

New page

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. Except with very good reason, do not use <code>px</code> which forces a fixed image width. A fixed width in pixels may only be specified where absolutely necessary.

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 {{para|height[n]}} and {{para|total_width}} parameters to obtain automatic resizing.
Note the different meanings of the {{para|width[n]}} parameters with versus without automatic resizing.
Please also note the option to set a {{para|total_width}} parameter at the beginning of the template:multiple image.

; No automatic resizing of all images to the same height

<syntaxhighlight lang="xml">
{{Multiple image|perrow = 1|total_width = 600

|align = 
|direction = 
|background color = 
|width = 
|caption_align = 
|image_style = 
|image_gap = 


|header_background = 
|header_align = 
|header = 


|image1 = 
|width1 = 
|alt1 =
|link1 =
|thumbtime1 =
|caption1 =


|image2 = 
|width2 = 
|alt2 =
|link2 =
|thumbtime2 =
|caption2 =




|footer_background = 
|footer_align = 
|footer = 
}}
</syntaxhighlight>

; Automatic resizing of all images to the same height and to a given total width

<syntaxhighlight lang="xml">
{{multiple image

|align = 
|direction = 
|background color = 
|total_width = 
|caption_align = 


|header_background =
|header_align = 
|header =


|image1 = 
|alt1 =
|link1 =
|thumbtime1 =
|caption1 =


|image2 = 
|alt2 =
|link2 =
|thumbtime2 =
|caption2 =




|footer_background =
|footer_align = 
|footer =
}}
</syntaxhighlight>

{| class=wikitable
! 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 {{para|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 {{para|total_width}} and {{para|width}}.
|-
| image''[n]''
| (where ''[n]'' = 1 to 10) Filename of [n]th image.
|-
| width''[n]''
| As above. Two meanings:
# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para|width}} if set.
# The full width of the original [n]th image if {{para|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 {{para|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).
* If this parameter is omitted altogether, the image will link to its image description page as usual.
* If this parameter is present but left empty (i.e. <code><nowiki>...|link1= |...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.
|-
| 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.
|-
| 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 ==

=== With footer ===

{{multiple image
|caption_align = center
|header = Pills
|width = 109
|image1 = Cumdoom pills icon.png
|link1 = [[Cumdoom pills]]
|alt1 = Cumdoom pills icon
|caption1 = Cumdoom
|image2 = Pregnax pills icon.png
|link2 = [[Pregnax pills]]
|alt2 = Pregnax pills icon
|caption2 = Pregnax
|footer = The pills are given by Dr. Singh
}}
<pre>
{{multiple image
|caption_align = center
|header = Pills
|width = 109
|image1 = Cumdoom pills icon.png
|link1 = [[Cumdoom pills]]
|alt1 = Cumdoom pills icon
|caption1 = Cumdoom
|image2 = Pregnax pills icon.png
|link2 = [[Pregnax pills]]
|alt2 = Pregnax pills icon
|caption2 = Pregnax
|footer = The pills are given by Dr. Singh
}}
</pre>

=== With background color, direction and links ===

{{multiple image
|background color = Grey
|direction = vertical
|header = Statue parts
|width = 109
|image1 = Mysterious statue (legs) icon.png
|link1 = Mysterious statue (legs)
|caption1 = Legs
|image2 = Mysterious statue (torso) icon.png
|link2 = Mysterious statue (torso)
|caption2 = Torso
|image3 = Mysterious statue (head) icon.png
|link3 = Mysterious statue (head)
|caption3 = Head
}}
<pre>
{{multiple image
|background color = Grey
|direction = vertical
|header = Statue parts
|width = 109
|image1 = Mysterious statue (legs) icon.png
|link1 = Mysterious statue (legs)
|caption1 = Legs
|image2 = Mysterious statue (torso) icon.png
|link2 = Mysterious statue (torso)
|caption2 = Torso
|image3 = Mysterious statue (head) icon.png
|link3 = Mysterious statue (head)
|caption3 = Head
}}
</pre>
{{clear}}

=== With multiple rows ===

To create an array of images, with multiple rows, use {{para|perrow}}. The value passed to {{para|perrow}} may be a single number, or a list of numbers delimited by <code>/</code>. This feature may also be combined with {{para|total_width}} for multiple rows of images with the same total width.

{{multiple image|perrow = 2|total_width = 300
|header = Aqua’s route main steps
|image1 = Raven Hill Treasure Scroll Tree Hole.jpg
|image2 = Treasure Moon puzzle.jpg
|image3 = Treasure Code.jpg
|image4 = Aqua Maze minigame icon.jpg
}}
<pre>
{{multiple image|perrow = 2|total_width = 300
|header = Aqua’s route main steps
|image1 = Raven Hill Treasure Scroll Tree Hole.jpg
|image2 = Treasure Moon puzzle.jpg
|image3 = Treasure Code.jpg
|image4 = Aqua Maze minigame icon.jpg
}}
</pre>

[[Category:Templates]]
[[Category:Templates documentation]]

← Older revision		Revision as of 18:52, 13 July 2020
Line 95:		Line 95:
	== Parameters ==		== Parameters ==

	; align : ~~right~~ (default), center, or left		; {{para\|align}} : Right (default), center, or left.
	; direction : ~~horizontal~~ (default) or vertical		; {{para\|direction}} : Horizontal (default) or vertical.
	; background color : To set the background color of the box in which the images appear.		; {{para\|background color}} : To set the background color of the box in which the images appear.
	; header_background :		; {{para\|header_background}} :
	; header_align : ~~center~~ (default), left, or right		; {{para\|header_align}} : Center (default), left, or right.
	; header :		; {{para\|header}} :
	; width : Use to set the same width for each image (i.e. overrides any {{para\|width{{var\|[n]}}}} below). Do not include if different image widths intended, including if images are to be resized to a fixed total width.		; {{para\|width}} : Use to set the same width for each image (i.e. overrides any {{para\|width{{var\|[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 {{para\|total_width}} and {{para\|width}}.		; {{para\|total_width}} : Use to scale the images to the same height and this total width. Do not use both {{para\|total_width}} and {{para\|width}}.
	; image{{var\|[n]}} : (where {{var\|[n]}} = 1 to 10) Filename of [n]th image.		; {{para\|image{{var\|[n]}}}} : (where {{var\|[n]}} = 1 to 10) Filename of [n]th image.
	; width{{var\|[n]}} : As above. Two meanings:		; {{para\|width{{var\|[n]}}}} : As above. Two meanings:
	:# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para\|width}} if set.		:# The width (in pixels, integer, omit “px”) of [n]th image. Overridden by {{para\|width}} if set.
	:# The full width of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width.		:# The full width of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width.
	; height{{var\|[n]}} : As above. The full height of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width. Ignored otherwise.		; {{para\|height{{var\|[n]}}}} : As above. The full height of the original [n]th image if {{para\|total_width}} is given in order to resize all images to the same height and a given total width. Ignored otherwise.
	; alt{{var\|[n]}} : As above. Alt description for [n]th image.		; {{para\|alt{{var\|[n]}}}} : As above. Alt description for [n]th image.
	; link{{var\|[n]}} : As above. The page linked to the [n]th image (i.e. the page that is loaded when the image is clicked).		; {{para\|link{{var\|[n]}}}} : As above. 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.		:* If this parameter is omitted altogether, the image will link to its image description page as usual.
	* If this parameter is present but left empty (i.e. <code><nowiki>...\|link1= \|...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.		:* If this parameter is present but left empty (i.e. <code><nowiki>...\|link1= \|...</nowiki></code>), the image will not link to anything – this should be the case only for purely decorative images.
	; thumbtime{{var\|[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.		; {{para\|thumbtime{{var\|[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.
	; caption{{var\|[n]}} : As above. Caption for the [n]th image.		; {{para\|caption{{var\|[n]}}}} : As above. Caption for the [n]th image.
	; caption_align : ~~left~~ (default), center, or right		; {{para\|caption_align}} : Left (default), center, or right.
	; footer_background :		; {{para\|footer_background}} :
	; footer_align : ~~left~~ (default), center, or right		; {{para\|footer_align}} : Left (default), center, or 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.		; {{para\|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 ==		== Examples ==