Difference between revisions of "Template:Gallery/doc"

From blackwiki
Jump to navigation Jump to search
imported>Eubulides
(Simplify discussion of difference.)
imported>Eubulides
(→‎Parameters: Move description of alt text into the "for each image" part of the documentation, for clarity and to match the example better.)
Line 11: Line 11:
 
== 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>|Image:''Filename''|alt''N''=''Alt text''|''Caption''</code>'''
 +
* '''<code>''Filename''</code>''' is the image's file name. It can use a '''<code>File:</code>''' instead of an '''<code>Image:</code>''' prefix.
 +
* '''<code>''N''</code>''' should be '''<code>1</code>''' for the first image, '''<code>2</code>''' for the second image, and so forth.
 +
* '''<code>''Alt text''</code>''' is the alt text for the image, used by visually impaired and other readers who cannot see the image. See ''[[Wikipedia:Alternative text for images]]''. If omitted, the image's alt text is blank.
 +
* '''<code>''Caption''</code>''' is the caption; see ''[[Wikipedia:Captions]]''.
  
=== Optional ===
+
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.
 +
 
 +
=== For the gallery overall ===
 +
 
 +
These parameters are optional.
 +
 
 +
; <code>title</code>: The gallery's title.
 +
; <code>width</code>: (default 180) Maximum width and height of each image.
 +
; <code>lines</code>: (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.
  
; title: The gallery's title.
 
; 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.
 
; alt#: with # being a number between 1 and 30. These allow you to specify a description of the image for the visual impaired. For more details read [[WP:ALT]].
 
 
== Example ==
 
== Example ==
  

Revision as of 18:05, 11 September 2009

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 <gallery> tag.

For style guidelines about where galleries are appropriate, see WP:IG.

This template is similar to {{Image gallery}}, except it requires a "File:" or "Image:" prefix for image names and an "altN=" prefix for alt text, whereas {{Image gallery}} requires neither prefix. Both templates use {{Gallery/aux}} to format individual images.

Parameters

For each image

Specify a line of the following form for each image.

|Image:Filename|altN=Alt text|Caption
  • Filename is the image's file name. It can use a File: instead of an Image: prefix.
  • N should be 1 for the first image, 2 for the second image, and so forth.
  • Alt text is the alt text for the image, used by visually impaired and other readers who cannot see the image. See Wikipedia:Alternative text for images. If omitted, the image's alt text is blank.
  • Caption is the caption; see Wikipedia:Captions.

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.

For the gallery overall

These parameters are optional.

title
The gallery's title.
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

Template:Pre2

See also