Template:Gallery/doc

DCCWiki, a community DCC encyclopedia.
Jump to: navigation, search

Template:Uses TemplateStyles

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 Template:Section link.

Blank syntax

{{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
}}

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
|mode= – Sets the mode used by the inner gallery tag. Common values include |mode=packed and |mode=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 |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.
|width= – Maximum width of each image, default is 180 pixels.
|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.

Examples

{{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 National Memorial]] in [[New York City]], overlooking [[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]]
}}

<templatestyles src="Template:Gallery/styles.css"></templatestyles>

{{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 National Memorial]] in [[New York City]], overlooking [[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]]
}}

<templatestyles src="Template:Gallery/styles.css"></templatestyles>

<templatestyles src="Template:Gallery/styles.css"></templatestyles>

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

ParameterDescriptionTypeStatus
titletitle

Title for the overall gallery

Example
Pictures of chickens
Stringsuggested
alignalign

Alignment of the gallery on the page; possible values include left, right, and center

Default
left
Example
center
Stringoptional
footerfooter

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
Stringoptional
stylestyle

This parameter allows an editor to utilize Cascading Style Sheet code

Unknownoptional
captionstylecaptionstyle

This parameter allows an editor to utilize Cascading Style Sheet code for caption

Unknownoptional
statestate

This parameter allows the editor to determine whether or not the gallery will initially appear as either expanded or collapsed for readers

Default
expanded
Example
collapsed
Stringoptional
heightheight

determines the maximum height for any image within the gallery

Default
180px
Example
100px
Stringoptional
widthwidth

Analogous to height parameter; sets maximum width for any image in the gallery

Default
180px
Example
120px
Stringoptional
modemode

Sets the mode used by the inner gallery tag, see Help:Gallery tag for more options

Default
traditional
Stringoptional
nobordernoborder

Cancel the border surrounding the images

Default
no
Example
yes
Stringoptional
whitebgwhitebg

Used to disable the white background in the inner gallery tag

Default
yes
Example
no
Stringoptional

Tracking categories

  • Template:Category link with count generates a link to a category followed by the number of pages in the category. It uses the PAGESINCATEGORY parser function.

    Usage

    One parameter
    {{Category link with count|CATEGORY}}
    {{clc|CATEGORY}}
    {{CLC|CATEGORY}}
    Two parameters
    {{Category link with count|CATEGORY|TYPE}}
    {{clc|CATEGORY|TYPE}}
    {{CLC|CATEGORY|TYPE}}
    Name label
    {{Category link with count|Category:Guans (bird)|name=CAT:Guans}}
    Template loop detected: Template:Clc

    Examples

    Using the template shortcut {{clc}}:

    One parameter

    without "Category:"
    {{clc|Côte-d'Or}}Template loop detected: Template:Clc
    with "Category:"
    {{clc|Category:Côte-d'Or}}Template loop detected: Template:Clc

    Two parameters

    without "Category:"
    {{clc|Côte-d'Or|pages}}Template loop detected: Template:Clc
    {{clc|Côte-d'Or|subcats}}Template loop detected: Template:Clc
    {{clc|Côte-d'Or|files}}Template loop detected: Template:Clc
    with "Category:"
    {{clc|Category:Côte-d'Or|pages}}Template loop detected: Template:Clc
    {{clc|Category:Côte-d'Or|subcats}}Template loop detected: Template:Clc
    {{clc|Category:Côte-d'Or|files}}Template loop detected: Template:Clc

    See also

    Template:Internal category-link templates


    • Template:Category link with count generates a link to a category followed by the number of pages in the category. It uses the PAGESINCATEGORY parser function.

      Usage

      One parameter
      {{Category link with count|CATEGORY}}
      {{clc|CATEGORY}}
      {{CLC|CATEGORY}}
      Two parameters
      {{Category link with count|CATEGORY|TYPE}}
      {{clc|CATEGORY|TYPE}}
      {{CLC|CATEGORY|TYPE}}
      Name label
      {{Category link with count|Category:Guans (bird)|name=CAT:Guans}}
      Template loop detected: Template:Clc

      Examples

      Using the template shortcut {{clc}}:

      One parameter

      without "Category:"
      {{clc|Côte-d'Or}}Template loop detected: Template:Clc
      with "Category:"
      {{clc|Category:Côte-d'Or}}Template loop detected: Template:Clc

      Two parameters

      without "Category:"
      {{clc|Côte-d'Or|pages}}Template loop detected: Template:Clc
      {{clc|Côte-d'Or|subcats}}Template loop detected: Template:Clc
      {{clc|Côte-d'Or|files}}Template loop detected: Template:Clc
      with "Category:"
      {{clc|Category:Côte-d'Or|pages}}Template loop detected: Template:Clc
      {{clc|Category:Côte-d'Or|subcats}}Template loop detected: Template:Clc
      {{clc|Category:Côte-d'Or|files}}Template loop detected: Template:Clc

      See also

      Template:Internal category-link templates


      See also