Difference between revisions of "Template:Gallery/doc"

From blackwiki
Jump to navigation Jump to search
imported>Baffle gab1978
m (typo)
imported>Great Brightstar
(Following Template:Multiple image/doc)
 
(116 intermediate revisions by 63 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:gallery]], using [[template:gallery/aux]], shows up to 30 images. Every image is embedded in its own HTML-table, and are floated left. 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 {{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 ==
 
== Parameters ==
  
=== Required ===
+
=== For each image ===
  
There are several parameters that should be specified after the tranclusion '''Gallery''':
+
Specify a line of the following form for each image.
 +
: <code>|File:''Filename''</code> {{para|alt''n''|''Alt text''}} <code>|''Caption''</code>
  
* '''lines''' the default is two, this parameter should be specified to the number of lines needed for the largest caption. If the specification is too low: the text will be cut off. If the specification is too high: excessive space is placed below the caption.
+
Where:
* <span style="color:#4444FF;"><span style="color:#000000; font-weight:bold;">|</span>[image]<span style="color:#000000; font-weight:bold;">|</span>[caption]</span> following the ''pipe'' symbol " [[Vertical bar|&#124;]] " (generally located above the enter key) the image location should be specified, if this parameter is not specified an image with a question mark is defaulted. Following a second ''pipe'', the caption should be specified, the default is a blank non-breaking space. Iterate the previous until all images are entered into the tranclusion, the limit is currently '''30'''.
+
: <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 ===
+
=== Optional parameters ===
  
There are several parameters that are optional to this transculsion:
+
These parameters apply to the gallery:
* '''title''' this parameter produces a title for the gallery
 
* '''width''' the default is 180px, this parameter specifies the maximum width and height of each image, and the width of each cell.
 
  
== Example ==
+
: {{para|title}} – The gallery's title
=== Code ===
+
: {{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]])
  
<pre>
+
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
 
{{Gallery
|title=Title of gallery goes here
+
|title=Cultural depictions of George Washington
|footer=*Image credit: Wikipedia, the free encyclopedia<br />**and so on...
+
|width=160 |height=170
|width=150
+
|align=center
|lines=2
+
|footer=Example 1
|Image:Wiki.png|this is a caption
+
|File:Federal Hall NYC 27.JPG
|Image:Wiki.png|
+
|alt1=Statue facing a city building with Greek columns and huge U.S. flag
|Image:Wiki.png|
+
|Statue of Washington outside [[Federal Hall National Memorial]] in [[New York City]], overlooking [[Wall Street]]
|Image:Wiki.png|
+
|File:Mount Rushmore2.jpg
|Image:Wiki.png|
+
|alt2=Profile of stone face on mountainside, with 3 workers.
|Image:Wiki.png|
+
|Construction of Washington portrait at [[Mount Rushmore]], c. 1932
|Image:Wiki.png|
+
|File:2006 Quarter Proof.png
|Image:Wiki.png|
+
|alt3=Shiny silver coin with profile of Washington bust.  
|Image:Wiki.png|[[Help:Contents/Links|Links]] can be put in captions.
+
|Washington is commemorated on a [[Quarter (United States coin)|quarter]].
|Image:Wiki.png|
+
|File:George Washington Presidential $1 Coin obverse.png
|Image:Wiki.png|
+
|alt4=Gold coin with bust of Washington facing slightly left
|Image:Wiki.png|
+
|Washington on a [[dollar coin (United States)|dollar coin]]
|Image:Wiki.png|Full [[MediaWiki]]<br />[[syntax]] may now be used…
 
|Image:Wiki.png|
 
 
}}
 
}}
</pre>
 
  
=== Result ===
+
{{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 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>}}
 +
{{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]]
 +
}}
  
<div style="background:#FFFFFF;">
 
 
{{Gallery
 
{{Gallery
|title=Title of gallery goes here
+
|title=Cultural depictions of George Washington
|width=150
+
|width=120 |height=100
|footer=*Image credit: Wikipedia (c)2008<br />**and so on...
+
|align=center
|lines=3
+
|footer=Example 2b
|Image:Wiki.png|this is a caption*
+
|File:Federal Hall NYC 27.JPG
|Image:Wiki.png|
+
|alt1=Statue facing a city building with Greek columns
|Image:Wiki.png|
+
|Statue of Washington outside [[Federal Hall National Memorial]] in [[New York City]], overlooking [[Wall Street]]
|Image:Wiki.png|
+
|File:Mount Rushmore2.jpg
|Image:Wiki.png|
+
|alt2=Profile of stone face on mountainside, with 3 workers.
|Image:Wiki.png|
+
|Work on Washington portrait at [[Mount Rushmore]], c. 1932
|Image:Wiki.png|
+
|File:2006 Quarter Proof.png
|Image:Wiki.png|
+
|alt3=Shiny silver coin with profile of Washington bust.  
|Image:Wiki.png|[[Help:Contents/Links|Links]] can be put in captions.
+
|Washington on a [[Quarter (United States coin)|quarter]]
|Image:Wiki.png|
+
|File:United_States_one_dollar_bill,_obverse.jpg
|Image:Wiki.png|
+
|alt4=Front side of U.S. dollar bill, with Washington portrait in center
|Image:Wiki.png|
+
|[[United States one-dollar bill|U.S. one-dollar bill]] – the caption here is still constrained by the width parameter.
|Image:Wiki.png|Full [[MediaWiki]]<br />[[syntax]] may now be used&hellip;**
+
|File:George Washington Presidential $1 Coin obverse.png
|Image:Wiki.png|
+
|alt5=Gold coin with bust of Washington facing left
 +
|Washington on a [[dollar coin (United States)|dollar coin]]
 
}}
 
}}
</div>
+
 
 +
==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"
 +
},
 +
"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 ==
 
== See also ==
* {{tl|cleanup-gallery}}, the template marking unencyclopedic image galleries.
+
* [[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>{{Sandbox other|
 +
| <!-- Categories below this line, please; interwikis at Wikidata -->
 +
[[Category:Image formatting and function templates]]
  
<span class="plainlinks" style="float:right;"><small>''[http://en.wikipedia.org/w/index.php?title=Template:Gallery&action=purge refresh page/purge cache]</small></span><!-- REMEMBER TO PURGE THE CACHE WHEN YOU'RE FINISHED EDITING THE PAGE --><br />
+
}}</includeonly>
<noinclude>
 
[[nl:Sjabloon:Gallery]]
 
[[no:Mal:Gallery]]
 
[[pt:Predefinição:Galeria]]
 
[[ta:வார்ப்புரு:Gallery]]
 
[[te:మూస:Gallery]]
 
[[Category:Template documentation]]
 
</noinclude></div>
 

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