Editing Template:Multiple image/doc

{{Documentation subpage}}
==Usage==
{{Lua|[[Module:Multiple image]]}}
This template is used to display multiple images in a box as if they were a single one, serving as an alternative to Fandom's [[W:c:community:Help:Galleries#Slideshows|slideshow galleries]]. The template supports up to ten images and offers a variety of styles. To use it in a page, type this:
<pre>
{{Multiple image
|align         = 
|direction     = 
|width         = 
|total_width   = 
|caption_align = 
|perrow        = 

|header_align  = 
|header        = 

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

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

|footer_align  = 
|footer        = 
}}
</pre>

==Parameters==
Some of the parameters allowed in the template are as follows:
*<code>align</code>: The position of the images relative to the text. The options are "right" (default), "left", "center", and "none".
*<code>direction</code>: The alignment of the images, either "horizontal" (default) or "vertical".
*<code>width</code>: The width of all the images. Omit "px" from the value. It should not be used along with "total_width" below.
*<code>total_width</code>: Sets a width for the entire thumbnail with the images therein sized accordingly. Omit "px" from the value. It should not be used along with "width" above.
*<code>caption_align</code>: The text alignment of the thumbnail captions, either "left" (default), center, or right.
*<code>perrow</code>: Use it to create an array of images with many rows.
*<code>header</code>: A header text put above the images.
*<code>header_align</code>: The text alignment of the header, either "center" (default), left, or right.
*<code>image[n]</code>: The file name and extension of the desired image, omitting the "File:" and "Image:" prefix. At least two are required, and up to ten can be added.
*<code>width[n]</code>: Sets an individual width for the desired image. Omit "px" from the value. Overriden by the "width" parameter above.
*<code>alt[n]</code>: An [[Wikipedia:WP:ALT|alternative text]] for the desired image.
*<code>link[n]</code>: A link to which the desired image leads when clicked on.
*<code>footer</code>: A footer text put below the images.
*<code>footer_align</code>: The text alignment of the footer, either "left" (default), center, or right.

==Examples==
{{Multiple image
|align     = right
|direction = horizontal
|width     = 140

|image1    = Sonic-the-Hedgehog-3-Japanese-Cover.jpg
|image2    = Sonic_&_Knuckles_(JP).jpg

|footer    = ''Sonic 3'' and ''Sonic & Knuckles''
}}
<pre>
{{Multiple image
|align     = right
|direction = horizontal
|width     = 140

|image1    = Sonic-the-Hedgehog-3-Japanese-Cover.jpg
|image2    = Sonic_&_Knuckles_(JP).jpg

|footer    = ''Sonic 3'' and ''Sonic & Knuckles''
}}
</pre>
{{-}}
{{Multiple image
|align     = left
|direction = vertical
|width     = 160

|header    = ''Sonic Generations''

|image1    = Sonic_Generations.jpg
|caption1  = The cover of the console/PC version...

|image2    = SG_630992_210762_front.jpg
|caption2  = ...and the cover of the 3DS version.
}}
<pre>
{{Multiple image
|align             = left
|direction         = vertical
|width             = 160

|header            = ''Sonic Generations''

|image1            = Sonic_Generations.jpg
|caption1          = The cover of the console/PC version...

|image2            = SG_630992_210762_front.jpg
|caption2          = ...and the cover of the 3DS version.
}}
</pre>
{{-}}
{{Multiple image
|align  = center
|header = With links (<code>link[n]</code>)

|image1 = Sonic-the-hedgehog-cdv2.png
|link1  = Sonic the Hedgehog
|image2 = Tails_1.png
|link2  = Tails
|image3 = Knuckles_Sonic3.png
|link3  = 

|footer_align = center
|footer       = Click on the left image to go to the [[Sonic the Hedgehog]] page, and on the center one to go to the [[Tails]] page. The Knuckles image doesn't lead anywhere when clicked.
}}
<pre>
{{Multiple image
|align        = center
|header       = With links (link[n])

|image1       = Sonic-the-hedgehog-cdv2.png
|link1        = Sonic the Hedgehog
|image2       = Tails_1.png
|link2        = Tails
|image3       = Knuckles_Sonic3.png
|link3        = 

|footer_align = center
|footer       = Click on the left image to go to the [[Sonic the Hedgehog]] page, and on the center one to go to the [[Tails]] page. The Knuckles image doesn't lead anywhere when clicked.
}}
</pre>
{{-}}
{{Multiple image
|align  = right
|header = With many rows (with <code>perrow</code>)
|width  = 150
|perrow = 2

|image1 = Sonic-Rush-Box-Art-US.png
|image2 = Sonic_Rush_Adventure.jpg
|image3 = The Dark Brotherhood.jpg
|image4 = Sonic Colors (DS).jpg

|footer = Games released for the DS. Clockwise from top left: ''Sonic Rush'', ''Sonic Rush Adventure'', ''Sonic Colors'', and ''Sonic Chronicles''.
}}
<pre>
{{Multiple image
|align  = right
|header = With many rows (perrow)
|width  = 150
|perrow = 2

|image1 = Sonic-Rush-Box-Art-US.png
|image2 = Sonic_Rush_Adventure.jpg
|image3 = The Dark Brotherhood.jpg
|image4 = Sonic Colors (DS).jpg

|footer = Games released for the DS. Clockwise from top left: ''Sonic Rush'', ''Sonic Rush Adventure'', ''Sonic Colors'', and ''Sonic Chronicles''.
}}
</pre>
{{-}}
==External links==
*[[w:c:dev:Global Lua Modules/Multiple image|Global Lua Modules/Multiple image]] on Fandom Developers Wiki
*[[Wikipedia:Template:Multiple image|Template:Multiple image]] on Wikipedia
<includeonly>
[[Category:Lua-based templates]]
[[Category:Gallery templates]]
</includeonly>