Template:Gallery/doc

Template:High-use

This template provides advanced gallery building functionality (fine-tuned formatting control). For creating generic galleries, use the Gallery tag.

This template displays a gallery of images in an array, left-to-right in rows. Global parameters |width= and |height= control the size of all images in the gallery. The number of images per row is based upon the image width parameters and the width of the screen. The number of images per row can change when the user resizes the window.

Blank syntax with all parameters

{{Gallery | title = | align = | footer = | style = | state = | height = | width = | perrow = | mode = | whitebg = | noborder = | captionstyle = | File: | Write a caption here | alt1= | File: | Write a caption here | alt2= | File: | Write a caption here | alt3= | File: | Write a caption here | alt4= | File: | Write a caption here | alt5= }}

Parameters

For each image

Specify a line of the following form for each image.

|File:Filename |Caption altn|alternative text

Note that the file name and the caption do not need parameter names, but each alt text parameter must be preceded by |altn=.

Where:

|File:Filename – the image's file name. Either File: or Image: prefix may be used

|Caption – the caption under the image

|altn= – alt attribute: |alt1= for the first image, |alt2= for the second image, etc

alternative text – the alternative text for the image, used by visually impaired or other readers who cannot see the image clearly. If omitted, the image's alt text will be blank.

Optional parameters

These parameters apply to the entire gallery:

title – The gallery's title

|align= – The alignment of the gallery on the page, left (default), center, or right; ignored when |state= is set

|footer= – Small, right-aligned text below the images

|style= – CSS style directives for the whole gallery

|state= – Sets the default state of collapsible galleries; use |state=expanded or |state=collapsed; collapsible galleries occupy the full page width

|mode= – Sets the mode used by the inner gallery tag. Common values include |mode=packed and |mode=nolines (see Support:Gallery for more options)

These parameters apply to all of the images in the gallery:

|noborder= – Cancel the border surrounding the images, use |noborder=yes to set.

|whitebg= – Cancel the white background after the images, use |whitebg=no to set.

|height= – Maximum height of each image. If this parameter is not included, |height= defaults to 180 pixels. Use a simple number here, e.g., 200, without a units designation (px, etc).

|width= – Maximum width of each image, default is 180 pixels. Use a number here, e.g., 150, without units(px, etc).

|perrow= – Number of images to display per row

|captionstyle= – CSS style directives for the captions

The image's original ratio of width to height cannot be modified by |width= or |height= – a rectangular image will not be made square if |width= and |height= are set to the same value.

TemplateData

Place this template on an article or user page to create a gallery of images on that page along with captions. Anyone may place this template.

Template parameters

Parameter		Description	Type	Status
title	title	Title for the overall gallery Example Pictures of chickens	String	suggested
align	align	Alignment of the gallery on the page; possible values include left, right, and center Suggested values left center right Default left Example center	String	optional
footer	footer	Creates a footer which will appear in the lower right corner of the overall gallery, in small font, of whatever text the editor placing it wishes to put there Example Early works	String	optional
CSS styling	style	Allows custom Cascading Style Sheets styling to be added to the gallery block. Example border: 1px solid black;	String	optional
captionstyle	captionstyle	This parameter allows an editor to utilize Cascading Style Sheet code for caption	Unknown	optional
state	state	This parameter allows the editor to determine whether or not the gallery will initially appear as either expanded or collapsed for readers Suggested values expanded collapsed Default expanded Example collapsed	String	optional
height	height	determines the maximum height for any image within the gallery Default 180 Example 100	Number	optional
width	width	Analogous to height parameter; sets maximum width for any image in the gallery Default 180 Example 120	Number	optional
mode	mode	Sets the mode used by the inner gallery tag, see Help:Gallery tag for more options Suggested values traditional nolines packed packed-overlay packed-hover slideshow Default traditional	String	optional
noborder	noborder	Cancel the border surrounding the images Default no Example yes	String	optional
whitebg	whitebg	Used to disable the white background in the inner gallery tag Default yes Example no	Boolean	optional

Tracking categories

• Category:Pages using gallery with unknown parameters
• Category:Pages using gallery with the captionstyle parameter

See also

• Support:Gallery tag

Notes

• This Template and its Module are originally from Wikipedia: https://en.wikipedia.org/wiki/Module:Gallery