Module:Gallery/doc

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.

For style guidelines about where galleries are appropriate, see.

For each image
Specify a line of the following form for each image.
 * 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:
 * – the image's file name. Either  or   prefix may be used
 * – the caption under the image; see Manual of Style/Captions
 * altn – alt attribute: alt1 for the first image, alt2 for the second image, etc
 * – 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 (see Help:Cascading Style Sheets)
 * state – Sets the default state of collapsible galleries; use expanded or collapsed; collapsible galleries occupy the full page width
 * mode – Sets the mode used by the inner gallery tag. Common values include packed and nolines (see Help:Gallery tag for more options)

These parameters apply to all of the images in the gallery:
 * noborder – Cancel the border surrounding the images, use yes to set.
 * whitebg – Cancel the white background after the images, use 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, e.g., 200px.
 * width – Maximum width of each image, default is 180 pixels. Use a number here, e.g., 150, without units, e.g., 150px.
 * captionstyle – CSS style directives for the captions (see Help:Cascading Style Sheets)

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
{	"params": { "title": { "label": "title", "description": "Title for the overall gallery", "example": "Pictures of chickens", "type": "string", "suggested": true },		"align": { "label": "align", "description": "Alignment of the gallery on the page; possible values include left, right, and center", "example": "center", "type": "string", "default": "left", "suggestedvalues": [ "left", "center", "right" ]		},		"footer": { "label": "footer", "description": "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", "type": "string" },		"style": { "label": "style", "description": "This parameter allows an editor to utilize Cascading Style Sheet code" },		"captionstyle": { "label": "captionstyle", "description": "This parameter allows an editor to utilize Cascading Style Sheet code for caption" },		"state": { "label": "state", "description": "This parameter allows the editor to determine whether or not the gallery will initially appear as either expanded or collapsed for readers", "example": "collapsed", "type": "string", "default": "expanded", "suggestedvalues": [ "expanded", "collapsed" ]		},		"height": { "label": "height", "description": "determines the maximum height for any image within the gallery", "example": "100", "type": "string", "default": "180" },		"width": { "label": "width", "description": "Analogous to height parameter; sets maximum width for any image in the gallery", "example": "120", "type": "string", "default": "180" },		"mode": { "label": "mode", "description": "Sets the mode used by the inner gallery tag, see Help:Gallery tag for more options", "type": "string", "default": "traditional", "suggestedvalues": [ "traditional", "nolines", "packed", "packed-overlay", "packed-hover", "slideshow" ]		},		"noborder": { "label": "noborder", "description": "Cancel the border surrounding the images", "example": "yes", "type": "string", "default": "no" },		"whitebg": { "label": "whitebg", "description": "Used to disable the white background in the inner gallery tag", "example": "no", "type": "string", "default": "yes" }	},	"description": "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." }