Vorlage:Multiple image/doc

Aus pm4u
< Vorlage:Multiple image
Version vom 31. Mai 2017, 09:29 Uhr von Vdusa (Diskussion | Beiträge) (1 Version importiert: Importing Template:Multiple image with dependencies)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

Vorlage:Mbox

This template creates a box with two to ten images arranged vertically or horizontally with captions for the entire box or for each 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 px"... "which forces a fixed image width. In most cases upright=scaling factor should be used, thereby respecting the user's base preference (which may have been selected for that user's particular devices).")

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

No automatic resizing of all images to the same height
<source lang="xml">

</source>

Automatic resizing of all images to the same height and to a given total width
<source lang="xml">

</source>

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)  To specify the page to which the [n]th image is linked (i.e. the page that is loaded when the image is clicked). If set as empty (e.g. ...|alt1=... |link1= |caption1=...), linking is disabled (even to the standard Wikipedia image description page); consider WP:ALT.
Note: This parameter must not be used with images that have been given free licenses (such as the GDFL or a free CC license) as these licenses require images to be linked to a declaration of the license under which they are being used.
thumbtime[n] (as above)  When using Ogg Theora 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.

Examples

Players are cautioned with a yellow card and sent off with a red card.
{{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.
}}
PNG transparency demonstration
A PNG image with an 8-bit transparency layer...
...here overlaying a checkered background.
{{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.
}}
When a user has many of one type of barnstar, they can represent them with ribbons and these numerals to indicate the count.
{{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

Adoxa (Adoxa moschatellina)

<source lang="moin" style="overflow:auto;">

Adoxa (Adoxa moschatellina)

</source>

With links (link[n])

A mule
(骡子 luózi)
A donkey
(驴子 lǘzi)
A fish
( )
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 standard image description page.

<source lang="moin" style="overflow:auto;">

A mule
(骡子 luózi)
A donkey
(驴子 lǘzi)
A fish
( )
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 standard image description page.

</source>

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).

(horizontal)
(vertical)

To match image heights

  • Decide on a total width for all the images, say 320px
  • Examine the individual image pages to obtain the full resolution. For example:
  • Specify the full width and height for each image, of the form:
    • |width1= |height1= |width2= |height2=
  • Set the total width using |total_width=
Rectangular image of a donkey, originally 536 pixels high.
Square image of a trout, originally 300 pixels high.
Both images have been rendered with the same height, and a total width of 320px
{{multiple image
 | align = right
 | total_width = 320

 | image1 = Donkey 1 arp 750px.jpg
 | width1 = 750 | height1 = 536
 | alt1 = A donkey
 | caption1 = Rectangular image of a donkey, originally 536 pixels high.

 | image2 = Rainbow_trout.png
 | width2 = 300 | height2 = 300
 | 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
}}

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.

Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, RTK GPS Base station.
{{multiple image|perrow = 2|total_width=300
| image1 = Kern_Theodolit_DKM2-A.jpg  |width1=319|height1=425
| image2 = Total-Robotic-Station.jpg  |width2=1728|height2=3072
| image3 = DumpyLevel.jpg  |width3=1600|height3=1200
| image4 = GPS_Survey_Equipment_at_Weir_Dyke_Bridge_-_geograph.org.uk_-_336908.jpg|width4=427|height4=640
| footer = Surveying Equipment. Clockwise from upper left: Optical Theodolite, Robotic total station, Optical level, [[Real-time kinematic | RTK]] GPS Base station.
}}

Removing the image border

The border around the images can be removed using |image_style=border:none.

Image of a donkey
Image of a trout
{{multiple image
 | align = right
 | total_width = 320
 | image_style = border:none;

 | image1 = Donkey 1 arp 750px.jpg
 | width1 = 750 | height1 = 536
 | alt1 = A donkey
 | caption1 = Image of a donkey

 | image2 = Rainbow_trout.png
 | width2 = 300 | height2 = 300
 | alt2 = A trout
 | caption2 = Image of a trout
}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for Multiple image

<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": "Alignment", "default": "right", "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", "suggested": true }, "direction": { "default": "horizontal", "type": "string", "label": "Direction", "description": "Direction in which to tile the images.", "example": "horizontal/vertical", "suggested": true }, "width": { "type": "string", "label": "Width", "description": "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", "example": "200", "suggested": true }, "background color": { "type": "string", "label": "Background color", "description": "Defines the background color between the border of the box and the images." }, "caption_align": { "default": "left", "type": "string", "label": "Caption alignment", "example": "left/right/center" }, "header_background": { "type": "string", "label": "Header background" }, "header_align": { "default": "center", "type": "string", "label": "Header alignment", "example": "left/right/center" }, "header": { "type": "string", "label": "Header" }, "image1": { "description": "Image 1 is name of first image. Similarly for Image 2, etc. File name only; no \"File:\" or \"Image:\" prefix.", "type": "string", "example": "example.jpg", "suggested": true, "label": "Image 1" }, "width1": { "description": "width 1 is width of first image. Similarly for Width 2, etc.", "type": "number", "label": "Width 1" }, "alt1": { "type": "string", "description": "The alt text of first image (see WP:ALT). Similarly for Alt text 2, etc.", "label": "Alt text 1" }, "caption1": { "type": "string", "description": "Caption 1 is caption of first image. Similarly for Caption 2, etc.", "suggested": true, "label": "Caption 1" }, "link1": { "type": "string", "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.\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.", "label": "Link 1" }, "thumbtime1": { "type": "string", "description": "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.", "label": "Thumbtime 1" }, "image2": { "example": "example.jpg", "suggested": true, "label": "Image 2", "type": "string" }, "width2": { "type": "string", "label": "Width 2" }, "alt2": { "label": "Alt text 2", "type": "string" }, "caption2": { "type": "string", "suggested": true, "label": "Caption 2" }, "link2": { "type": "string", "label": "Link 2" }, "thumbtime2": { "type": "string", "label": "Thumbtime 2" }, "image3": { "type": "string", "example": "example.jpg", "label": "Image 3" }, "width3": { "type": "string", "label": "Width 3" }, "alt3": { "type": "string", "label": "Alt text 3" }, "caption3": { "label": "Caption 3", "type": "string" }, "link3": { "label": "Link 3", "type": "string" }, "thumbtime3": { "type": "string", "label": "Thumbtime 3" }, "footer_background": { "type": "string", "label": "Footer background" }, "footer_align": { "default": "left", "type": "string", "label": "Footer alignment", "example": "left/right/center" }, "footer": { "type": "string", "label": "Footer" } }, "format": "block" } </templatedata>

See also