View source for Template:Gallery/doc

{{Documentation subpage}}
{{Warning|1={{big|Before making a gallery, please read over the '''[[WP:IG|image use policy for galleries]]'''. Generally, a gallery '''should not be added''' so long as there is space for images to be effectively presented adjacent to text.}}
}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{For|the cleanup tag|Template:Cleanup gallery}}
{{#ifeq:{{FULLPAGENAME}}|Template:Gallery|{{High-use|6773}}}}
{{Lua|Module:Gallery}}
{{Uses TemplateStyles|Template:Gallery/styles.css}}

This template provides advanced gallery building functionality (fine-tuned formatting control). For creating basic galleries, use the [[Wikipedia:Gallery tag|Gallery tag]].

This template displays a gallery of images in an array, left-to-right in rows.  Global parameters {{para|width}} and {{para|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 {{section link|Wikipedia:Image use policy#Image galleries}}.

== Blank syntax ==
{| style="background: transparent;"
|<pre>{{Gallery
| title        = 
| align        =
| footer       =
| style        =
| state        =
| height       =
| width        =
| captionstyle =
| File:
 | alt1=
 | Write a caption here
| File:
 | alt2=
 | Write a caption here
| File:
 | alt3=
 | Write a caption here
| File:
 | alt4=
 | Write a caption here
| File:
 | alt5=
 | Write a caption here
}}</pre>
|}

== Parameters ==

=== For each image ===

Specify a line of the following form for each image.
: <code>|File:''Filename''</code> {{para|alt''n''|''Alt text''}} <code>|''Caption''</code>

Where:
: <code>|File:''Filename''</code> – the image's file name. Either <code>File:</code> or <code>Image:</code> prefix may be used
: {{para|Alt''n''}} – [[alt attribute]]: {{para|alt1}} for the first image, {{para|alt2}} for the second image, etc
:: <code>''Alt text''</code> – the [[Wikipedia:Alternative text for images|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.
: <code>|''Caption''</code> – the caption under the image; see [[Wikipedia:Manual of Style/Captions]]

=== Optional parameters ===

These parameters apply to the gallery:

: {{para|title}} – The gallery's title
: {{para|align}} – The alignment of the gallery on the page, left (default), center, or right; ignored when {{para|state}} is set
: {{para|footer}} – Small, right-aligned text below the images
: {{para|style}} – [[Cascading Style Sheets|CSS]] style directives for the whole gallery (see [[Help:Cascading Style Sheets]])
: {{para|state}} – Sets the default state of collapsible galleries; use {{para|state|expanded}} or {{para|state|collapsed}}; collapsible galleries occupy the full page width
: {{para|mode}} – Sets the mode used by the inner gallery tag.  Common values include {{para|mode|packed}} and {{para|mode|nolines}} (see [[Help:Gallery tag]] for more options) 
These parameters apply to all of the images in the gallery:
: {{para|noborder}} – Cancel the border surrounding the images, use {{para|noborder|yes}} to set.
: {{para|height}} – Maximum height of each image. If this parameter is not included, {{para|height}} defaults to 180 pixels.
: {{para|width}} – Maximum width of each image, default is 180 pixels.
: {{para|captionstyle}} – [[Cascading Style Sheets|CSS]] style directives for the captions (see [[Help:Cascading Style Sheets]])

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

== Examples ==
{{pre2|scroll|<nowiki>{{Gallery
|title=Cultural depictions of George Washington
|width=160 | height=170
|align=center
|footer=Example 1
|File:Federal Hall NYC 27.JPG 
 |alt1=Statue facing a city building with Greek columns and huge U.S. flag
 |Statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]]
|File:Mount Rushmore2.jpg 
 |alt2=Profile of stone face on mountainside, with 3 workers.
 |Construction of Washington portrait at [[Mount Rushmore]], c. 1932
|File:2006 Quarter Proof.png 
 |alt3=Shiny silver coin with profile of Washington bust. 
 |Washington is commemorated on a [[Quarter (United States coin)|quarter]].
|File:George Washington Presidential $1 Coin obverse.png 
 |alt4=Gold coin with bust of Washington facing slightly left
 |Washington on a [[dollar coin (United States)|dollar coin]]
}}</nowiki>}}
{{Gallery
|title=Cultural depictions of George Washington
|width=160 |height=170
|align=center
|footer=Example 1
|File:Federal Hall NYC 27.JPG
|alt1=Statue facing a city building with Greek columns and huge U.S. flag
 |Statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]]
|File:Mount Rushmore2.jpg
|alt2=Profile of stone face on mountainside, with 3 workers.
 |Construction of Washington portrait at [[Mount Rushmore]], c. 1932
|File:2006 Quarter Proof.png
|alt3=Shiny silver coin with profile of Washington bust. 
 |Washington is commemorated on a [[Quarter (United States coin)|quarter]].
|File:George Washington Presidential $1 Coin obverse.png
|alt4=Gold coin with bust of Washington facing slightly left
 |Washington on a [[dollar coin (United States)|dollar coin]]
}}

{{pre2|scroll|<nowiki>{{Gallery
|title=Cultural depictions of George Washington
|width=120 |height=100
|align=center
|footer=Example 2a
|File:Federal Hall NYC 27.JPG
 |alt1=Statue facing a city building with Greek columns
 |Statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]]
|File:Mount Rushmore2.jpg
 |alt2=Profile of stone face on mountainside, with 3 workers.
 |Work on Washington portrait at [[Mount Rushmore]], c. 1932
|File:2006 Quarter Proof.png
 |alt3=Shiny silver coin with profile of Washington bust. 
 |Washington on a [[Quarter (United States coin)|quarter]]
|File:United_States_one_dollar_bill,_obverse.jpg
 |alt4=Front side of U.S. dollar bill, with Washington portrait in center.
 |[[United States one-dollar bill|U.S. one-dollar bill]]
|File:George Washington Presidential $1 Coin obverse.png
 |alt5=Gold coin with bust of Washington facing left
 |Washington on a [[dollar coin (United States)|dollar coin]]
}}</nowiki>}}
{{Gallery
|title=Cultural depictions of George Washington
|width=120 |height=100
|align=center
|footer=Example 2a
|File:Federal Hall NYC 27.JPG
|alt1=Statue facing a city building with Greek columns
 |Statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]]
|File:Mount Rushmore2.jpg
|alt2=Profile of stone face on mountainside, with 3 workers.
 |Work on Washington portrait at [[Mount Rushmore]], c. 1932
|File:2006 Quarter Proof.png
|alt3=Shiny silver coin with profile of Washington bust. 
 |Washington on a [[Quarter (United States coin)|quarter]]
|File:United_States_one_dollar_bill,_obverse.jpg
|alt4=Front side of U.S. dollar bill, with Washington portrait in center.
 |[[United States one-dollar bill|U.S. one-dollar bill]]
|File:George Washington Presidential $1 Coin obverse.png
|alt5=Gold coin with bust of Washington facing left
 |Washington on a [[dollar coin (United States)|dollar coin]]
}}

{{Gallery
|title=Cultural depictions of George Washington
|width=120 |height=100
|align=center
|footer=Example 2b
|File:Federal Hall NYC 27.JPG
|alt1=Statue facing a city building with Greek columns
 |Statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]]
|File:Mount Rushmore2.jpg
|alt2=Profile of stone face on mountainside, with 3 workers.
 |Work on Washington portrait at [[Mount Rushmore]], c. 1932
|File:2006 Quarter Proof.png
|alt3=Shiny silver coin with profile of Washington bust. 
 |Washington on a [[Quarter (United States coin)|quarter]]
|File:United_States_one_dollar_bill,_obverse.jpg 
|alt4=Front side of U.S. dollar bill, with Washington portrait in center 
 |[[United States one-dollar bill|U.S. one-dollar bill]] – the caption here is still constrained by the width parameter.
|File:George Washington Presidential $1 Coin obverse.png
|alt5=Gold coin with bust of Washington facing left
 |Washington on a [[dollar coin (United States)|dollar coin]]
}}

==TemplateData==
<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"
		},
		"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"
		},
		"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"
		},
		"height": {
			"label": "height",
			"description": "determines the maximum height for any image within the gallery",
			"example": "100px",
			"type": "string",
			"default": "180px"
		},
		"width": {
			"label": "width",
			"description": "Analogous to height parameter; sets maximum width for any image in the gallery",
			"example": "120px",
			"type": "string",
			"default": "180px"
		}
	},
	"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."
}
</templatedata>

== Tracking categories ==
* {{clc|Pages using gallery with unknown parameters}}
* {{clc|Pages using gallery with the captionstyle parameter}}

== See also ==
* [[Help:Gallery tag]]
* {{tl|Cleanup gallery}}, to mark unencyclopedic image galleries
* {{tl|Gallery layout}}, to apply Gallery-style layout to arbitrary blocks of content such as template output
* {{tl|Image array}}
* {{tl|Image frame}}
* {{tl|Multiple image}}
* {{tl|Photomontage}}
* {{tl|Gallery Featurepic}}
* {{tl|Stack}}, where images etc. can be stacked down right hand side avoiding spacing and floating problems

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | 
| <!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Image formatting and function templates]]

}}</includeonly>