Template:Gallery/doc

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

{{#invoke:Message box|mbox}} {{#invoke:Lua banner|main}}

{{#invoke:Hatnote|hatnote}}

This template provides advanced gallery building functionality (such as scrolling captions and fine-tuned formatting control). For creating basic 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 unless overridden by an image's |widthn= parameter. 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 §Image galleries of Wikipedia's Image use policy.

Parameters

For each image

Specify a line of the following form for each image.

|File:Filename |altn=Alt text |Caption

Where:

|File:Filename – the image's file name. Either File: or Image: prefix may be used
|Altn=alt attribute: |alt1= for the first image, |alt2= for the second image, etc
Alt 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.
|Caption – the caption under the image; see Wikipedia:Manual of Style/Captions

Optional parameters

These parameters apply to the 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 |state=expanded or |state=collapsed; collapsible galleries occupy the full page width

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

|height= – Maximum height of each image. If this parameter is not included, |height= defaults to 180 pixels.
|width= – Maximum width of each image, default is 180 pixels.
|cellwidth= – Width of each image cell or box, default is |width=). If specified, |cellwidth= overrides any value specified with |width=.
|lines= – The number of text lines needed for the largest caption (default: 2 lines).

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.

These parameters apply to each image, separately:

|widthn= (where n is a number) – specifies the width of image n when it needs to be different from the value specified by |width=

Note that making an image wider with the |widthn= parameter does not produce a wider caption, which will still be constrained by the |width= parameter.

Examples

{{Gallery
|title=Cultural depictions of George Washington
|width=160 | height=170 | lines=4
|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]]
}}

{{#invoke: Gallery | gallery}}

{{Gallery
|title=Cultural depictions of George Washington
|width=120 |height=100 |lines=4
|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 | width4=200 |
 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]]
}}

{{#invoke: Gallery | gallery}} Note how in the above example, the parameter |width4=200 sets the width of image 4, to allow the dollar-bill image to be wider than the other images in the gallery. However, the width of the caption remains at 120px, as set by the |width=120 parameter.

{{#invoke: Gallery | gallery}}

See also