Template:Gallery

Template documentationviewedithistorypurge

For the cleanup tag, see Template:Cleanup gallery.

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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|width= and <syntaxhighlight lang="wikitext" inline style="display: none;" />|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 Wikipedia:Image use policy § Image galleries.

Blank syntax with all parameters

<syntaxhighlight lang="wikitext" copy> </syntaxhighlight>

Parameters

For each image

Specify a line of the following form for each image.

|File:Filename |Caption <syntaxhighlight lang="wikitext" inline style="display: none;" />|altn=alternative text <syntaxhighlight lang="wikitext" inline style="display: none;" />|classn=CSS class

Note that the file name and the caption do not need parameter names, but each alt text parameter must be preceded by <syntaxhighlight lang="wikitext" inline style="display: none;" />|altn=.

Where:

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

|Caption – the caption under the image; see Wikipedia:Manual of Style/Captions. If there is a need to use the equal sign, it must be escaped by using {{=}}, but it is not required for <ref name='tag'> in the caption. (details)

<syntaxhighlight lang="wikitext" inline style="display: none;" />|altn= – alt attribute: <syntaxhighlight lang="wikitext" inline style="display: none;" />|alt1= for the first image, <syntaxhighlight lang="wikitext" inline style="display: none;" />|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.

<syntaxhighlight lang="wikitext" inline style="display: none;" />|classn=CSS class - it currently only allows two options, used for darkmode settings: skin-invert-image and bg-transparent

Optional parameters

These parameters apply to the entire gallery:

<syntaxhighlight lang="wikitext" inline style="display: none;" />|title= – The gallery's title

<syntaxhighlight lang="wikitext" inline style="display: none;" />|align= – The alignment of the gallery on the page, left (default), center, or right; ignored when <syntaxhighlight lang="wikitext" inline style="display: none;" />|state= is set

<syntaxhighlight lang="wikitext" inline style="display: none;" />|footer= – Small, right-aligned text below the images

<syntaxhighlight lang="wikitext" inline style="display: none;" />|style= – CSS style directives for the whole gallery (see Help:Cascading Style Sheets)

<syntaxhighlight lang="wikitext" inline style="display: none;" />|state= – Sets the default state of collapsible galleries; use <syntaxhighlight lang="wikitext" inline style="display: none;" />|state=expanded or <syntaxhighlight lang="wikitext" inline style="display: none;" />|state=collapsed; collapsible galleries occupy the full page width

<syntaxhighlight lang="wikitext" inline style="display: none;" />|mode= – Sets the mode used by the inner gallery tag. Common values include <syntaxhighlight lang="wikitext" inline style="display: none;" />|mode=packed and <syntaxhighlight lang="wikitext" inline style="display: none;" />|mode=nolines (see Help:Gallery tag for more options)

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

<syntaxhighlight lang="wikitext" inline style="display: none;" />|noborder= – Cancel the border surrounding the images, use <syntaxhighlight lang="wikitext" inline style="display: none;" />|noborder=yes to set.

<syntaxhighlight lang="wikitext" inline style="display: none;" />|whitebg= – Cancel the white background after the images, use <syntaxhighlight lang="wikitext" inline style="display: none;" />|whitebg=no to set.

<syntaxhighlight lang="wikitext" inline style="display: none;" />|height= – Maximum height of each image. If this parameter is not included, <syntaxhighlight lang="wikitext" inline style="display: none;" />|height= defaults to 180 pixels. Use a simple number here, e.g., 200, without a units designation, e.g., 200px.

<syntaxhighlight lang="wikitext" inline style="display: none;" />|width= – Maximum width of each image, default is 180 pixels. Use a number here, e.g., 150, without units, e.g., 150px.

<syntaxhighlight lang="wikitext" inline style="display: none;" />|perrow= – Number of images to display per row

<syntaxhighlight lang="wikitext" inline style="display: none;" />|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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|width= or <syntaxhighlight lang="wikitext" inline style="display: none;" />|height= – a rectangular image will not be made square if <syntaxhighlight lang="wikitext" inline style="display: none;" />|width= and <syntaxhighlight lang="wikitext" inline style="display: none;" />|height= are set to the same value.

Examples

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

Cultural depictions of George Washington

• Statue facing a city building with Greek columns and huge U.S. flag
  Statue of Washington outside Federal Hall National Memorial in New York City, overlooking Wall Street
• Profile of stone face on mountainside, with 3 workers.
  Construction of Washington portrait at Mount Rushmore, c. 1932
• Shiny silver coin with profile of Washington bust.​​‌
  Washington is commemorated on a quarter.
• Gold coin with bust of Washington facing slightly left​​‌
  Washington on a dollar coin

Example 1

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

Cultural depictions of George Washington

• Statue facing a city building with Greek columns
  Statue of Washington outside Federal Hall National Memorial in New York City, overlooking Wall Street
• Profile of stone face on mountainside, with 3 workers.
  Work on Washington portrait at Mount Rushmore, c. 1932
• Shiny silver coin with profile of Washington bust.​​‌
  Washington on a quarter
• Front side of U.S. dollar bill, with Washington portrait in center.
  U.S. one-dollar bill
• Gold coin with bust of Washington facing left​​‌
  Washington on a dollar coin

Example 2a

Cultural depictions of George Washington

• Statue facing a city building with Greek columns
  Statue of Washington outside Federal Hall National Memorial in New York City, overlooking Wall Street
• Profile of stone face on mountainside, with 3 workers.
  Work on Washington portrait at Mount Rushmore, c. 1932
• Shiny silver coin with profile of Washington bust.​​‌
  Washington on a quarter
• Front side of U.S. dollar bill, with Washington portrait in center
  U.S. one-dollar bill – the caption here is still constrained by the width parameter.
• Gold coin with bust of Washington facing left​​‌
  Washington on a dollar coin

Example 2b

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", "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": "CSS styling", "description": "Allows custom Cascading Style Sheets styling to be added to the gallery block.", "example": "border: 1px solid black;", "type": "string" }, "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": "number", "default": "180" }, "width": { "label": "width", "description": "Analogous to height parameter; sets maximum width for any image in the gallery", "example": "120", "type": "number", "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": { "description": "Used to disable the white background in the inner gallery tag", "example": "no", "type": "boolean", "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." } </templatedata>

Tracking categories

• Category:Pages using gallery without a media namespace prefix (0)
• Category:Pages using gallery with potential alt text mismatch (0)
• Category:Pages using gallery with the captionstyle parameter (0)
• Category:Pages using gallery with unknown parameters (0)

See also

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

The above documentation is transcluded from Template:Gallery/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.