Difference between revisions of "Template:Gallery/doc"

From blackwiki
Jump to navigation Jump to search
imported>ChyranandChloe
(cleanup)
imported>Great Brightstar
(Following Template:Multiple image/doc)
 
(110 intermediate revisions by 59 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{Warning|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}}
  
{{For|the cleanup tag|Template:Cleanup-gallery}}
+
This template provides advanced gallery building functionality (fine-tuned formatting control). For creating generic galleries, use the [[Wikipedia:Gallery tag|Gallery tag]].
  
This template shows up to 30 images in an array. The number of images per row is based upon the width specified and the width of the screen, which allows greater flexibility than the [[Wikipedia:Gallery tag|&#60;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 [[WP:IG]].
+
For style guidelines about where galleries are appropriate, see {{section link|Wikipedia:Image use policy#Image galleries}}.
  
This template is similar to {{tl|Image gallery}}, except that it does not support [[WP:ALT|alt text]] and thus does not produce galleries that are accessible to visually-impaired readers. Also, this template requires a "<code>File:</code>" or "<code>Image:</code>" prefix for image names, whereas {{tl|Image gallery}} does not. Both templates use {{tl|Gallery/aux}} to format individual images.
+
== 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 ==
 
== Parameters ==
  
=== Required ===
+
=== For each image ===
  
; |''Image''|''Caption'': Specify one of these lines for each image. '''''Image''''' is the image name (with a <code>File:</code> or <code>Image:</code> prefix). '''''Caption''''' is the caption; see [[WP:CAPTION]]. If no such lines are present, a gallery with a single question-mark image is produced. There is currently a limit of 30 such lines.
+
Specify a line of the following form for each image.
 +
: <code>|File:''Filename''</code> {{para|alt''n''|''Alt text''}} <code>|''Caption''</code>
  
=== Optional ===
+
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]]
  
; title: The gallery's title.
+
=== Optional parameters ===
; width: (default 180) Maximum width and height of each image.
 
; lines: (default 2) The number of text lines needed for the largest caption. Blank lines are appended to smaller captions. A caption that does not fit is cut off.
 
  
== Example ==
+
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|whitebg}} – Cancel the white background after the images, use {{para|whitebg|no}} 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 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]]
 +
}}</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 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]]
 +
}}
  
 
{{pre2|scroll|<nowiki>{{Gallery
 
{{pre2|scroll|<nowiki>{{Gallery
 
|title=Cultural depictions of George Washington
 
|title=Cultural depictions of George Washington
|lines=4
+
|width=120 |height=100
|Image:Federal Hall NYC 27.JPG|The statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]].
+
|align=center
|Image:Mount Rushmore2.jpg|Construction on the George Washington portrait at [[Mount Rushmore]], c. 1932.
+
|footer=Example 2a
|Image:2006 Quarter Proof.png|Washington is commemorated on the [[Quarter (United States coin)|quarter]].
+
|File:Federal Hall NYC 27.JPG
|Image:George Washigton Presidential $1 Coin obverse.png|Washington is also commemorated on some [[dollar coin (United States)|dollar coins]].
+
|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]]
 
}}</nowiki>}}
 
}}</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 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]]
 +
}}
  
 
{{Gallery
 
{{Gallery
 
|title=Cultural depictions of George Washington
 
|title=Cultural depictions of George Washington
|lines=4
+
|width=120 |height=100
|Image:Federal Hall NYC 27.JPG|The statue of Washington outside [[Federal Hall]] in [[New York City]], looking on [[Wall Street]].
+
|align=center
|Image:Mount Rushmore2.jpg|Construction on the George Washington portrait at [[Mount Rushmore]], c. 1932.
+
|footer=Example 2b
|Image:2006 Quarter Proof.png|Washington is commemorated on the [[Quarter (United States coin)|quarter]].
+
|File:Federal Hall NYC 27.JPG
|Image:George Washigton Presidential $1 Coin obverse.png|Washington is also commemorated on some [[dollar coin (United States)|dollar coins]].
+
|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]] – 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]]
 
}}
 
}}
  
==See also==
+
==TemplateData==
* {{tl|Image gallery}}
+
<templatedata>
* {{tl|Cleanup-gallery}}, the template marking unencyclopedic image galleries.
+
{
* {{tl|Scroll gallery}}
+
"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"
 +
},
 +
"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"
 +
},
 +
"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"
 +
},
 +
"mode": {
 +
"label": "mode",
 +
"description": "Sets the mode used by the inner gallery tag, see Help:Gallery tag for more options",
 +
"type": "string",
 +
"default": "traditional"
 +
},
 +
"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."
 +
}
 +
</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|Gallery items}}
 +
* {{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>
+
<includeonly>{{Sandbox other|
[[Category:Template documentation]]
+
| <!-- Categories below this line, please; interwikis at Wikidata -->
 +
[[Category:Image formatting and function templates]]
  
[[fa:الگو:نگارخانه]]
+
}}</includeonly>
[[nl:Sjabloon:Gallery]]
 
[[no:Mal:Gallery]]
 
[[pt:Predefinição:Galeria]]
 
[[ta:வார்ப்புரு:Gallery]]
 
[[te:మూస:Gallery]]
 
</includeonly>
 

Latest revision as of 15:33, 21 September 2020

Script error: No such module "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 Script error: No such module "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

Template:Pre2

Template:Pre2

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

See also