Template:G/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:G.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာ မန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha ∙ Tiếng Việt ∙ 简体中文 ∙ 繁體中文 ∙ +/−

Displays a gallery of files, using just the conventional <gallery> tag,
but with shorter parametrizing and some useful defaults.

Such a gallery can contain one file or more, up to an unlimited number:

  • with just {{ G | filename }} a 'gallery' of a single file can be shown,

  • with e.g. {{ G | filename1 | filename2 | ... }} more files are displayed.

The display format can be influenced by several additional options.


Usage

{{G |1= }}

Template parameters

ParameterDescriptionDefaultStatus
1(list of) file(s) to be displayed, can be in different ⇒ notationsemptysuggested
f
format
one of the six numbers to specify the ⇒ format: 0 to 5
whether or how the displayed image(s) should be captioned		10(or 2)optional
m
mode
gallery mode, can be specified with
t or traditional
n or nolines,
p or packed,
h or packed-hover,
o or packed-overlay,
s or slideshow
when parameter format is not specified, nolines is defaulted,
but that defaulting can be avoided with an empty mode parameter m=


empty




nolines		optional
c
caption
gallery caption (may be shifted to the left with e.g. some trailing &emsp; entities)emptyoptional
p
perrow
pictures per rowemptyoptional
s
style
style attributes, e.g. s=float:rightemptyoptional
a
attr, class
class attributes: any wikimedia class;
or the special code "c" (a=c) for a global <center> tag		emptyoptional
w
widths
width for the displaysemptyoptional
h
heights
height for the displaysemptyoptional
d
display
display size; can specify widths and heightsemptyoptional
n
notself
when invoked from a file: don't display the image itselfemptyoptional

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: all users

See also

The (reduced) Gallery Function of Template:{{F}}
Another solution: Template:{{Gallery}} and {{Gallery items}}

On meta: m:Help:Images and other uploaded files#Gallery

Some Lua-based iteration templates have an option to invoke the gallery function; mainly the templates
Derivative versions and Other versions, as well as Filelist and File can invoke either one of Iteration or Galeria.

For easy switching between both modules, their shortcode character parameters won't conflict.

But for the language gallery of a multi-language file, use one of

Localization

This template is not intended to be localized.

The parameter "w", "d", "h"

The display size can be specified with either widths and/or heights, or with display.
While "w" and "h" can specify the number of the pixels, "d" consists of three optional parts: [w] [xh] [px].
"w" and/or "h" have precedence: "d" is only checked when neither "w" nor "h" are specified.

The parameter "format"

can specify one of the following numbers how naming captions for the single files are displayed:

  2. no naming; same as specifying an empty f= , or another value
  3. naming with the "showfilename" option
  4. naming with the second value of parameter pairs (default is the first value, linked)
  5. same as format=2 but the defaults are displayed without link
  6. same as format=2 (default is the first value, linked, but without the extension)
  7. same as format=4 but the name is not linked
Note: While options like "showfilename" or "mode=slideshow" are deprecated in namespaces as e.g. articles or galleries, they can be very useful in e.g. file descriptions, or talk pages.

When format and width and mode are missing, mode becomes defaulted with nolines.

Defaulting the "format"

This parameter is a necessary addition to the parameters used by <gallery>.
When the most frequent invocation form for <gallery> is used, i.e.

  • the first parameter is preceded by a linefeed,
  • and the second parameter exists,
  • and it is separated from the first one by a pipe,
  • and it does not also end with a . and file extension

then no format must be specified, "f=2" is assumed, and
the display with {{G| ... }} is the almost same as with <gallery> ... </gallery>.
When not all these requirements are fulfilled, the parameter needs to be specified!
Otherwise a missing format parameter is defaulted with "f=1".

MWMWMWMBe aware: There are other valid possibilities to specify the parameters;
but only the form as described above will result in the "format" defaulting.

File list notations

The list of the files ("items") for the gallery can be specified in the notation

List 1
{{ G | file1.ext | file2.ext | ... | filen.ext | more parameters }}

or as a list separated by mandatory linefeeds

List 2
{{ G | 
file1.ext
file2.ext
...
filen.ext
 | more parameters }}

Also a mixture of both notations is possible.

The file names ("items") are specified with unnamed parameters.

With 1=, 2=, 3= up to n= an unlimited number of items can be specified.
Each unnamed parameter (p1 to p∞) can contain an unlimited number of linefeed-separated items.

(See also the overview).

For format=2 parameter pairs of file + description must be specified:

List 3
{{ G | file1.ext | description1 | file2.ext | description2 | ... | filen.ext | descriptionn |  f = 2 | more parameters }}

This format needs always parameter pairs, but the description may be without value (just a pipe or an empty new line).
When the description is empty, the name of the file is displayed instead; but a description as e.g. &nbsp; will be used!

For format=2 care should be taken when defining the items; it does not matter
whether they are pipe-separated or linefeed-separated, but file names are defined with item1, item3, item5, ...
while the descriptions are defined with the corresponding item2, item4, item6, ...
Description items can be specified empty, but file name items ought to contain a value.

A good idea for an easy way to read input will be (with the possibility not to need the 'format' parameter)

{{ G | 
file1.ext | name1
file2.ext | name2
...
 | more parameters }}

Indentions

Indentions are not intended by the gallery tag, if any are required the aligne attribute of tables can be used, e.g. 

{|
|style="padding-left:2em"|{{G|..... }}
|}

Examples

Shows different parametrizings, and item notations (separation with "pipes" and linefeeds).

0 just one file without option parameters

{{G| Example.png}}


That image can as well be obtained with
<gallery mode="nolines" showfilename="yes">
Example.png</gallery>
0 some files, without option parameters



{{G|Example ba.svg|Example de.svg|Example bn.svg|Example de.svg|Example en.svg|Example ru.svg|Example lt.svg|Example ro.svg|Example tr.svg}}
  • eight smileys                        
 
{{G|Day-template.svg
Emojione 1F642.svg
Emojione BW 1F642.svg
Laughing-smiley.svg
Noto Emoji Oreo 1f642.svg
Noto Emoji Pie 1f642.svg
Line-style-icons-happy.svg
Nuvola emoticon - happy.svg
|c=eight smileys &emsp; &emsp;|f=0|w=48|m=n}}
 0 globally centered with a=c

{{G|Blue king.svg|Chess kgt45.svg
|Chess krt45.svg|Chess kyt45.svg
|Green king.svg|Red king.svg
|Yellow king.svg|Chess kdt45.svg
|f=0|w=80|p=4|a=c}}
0 Some descriptions are missing 



{{G|
File:Pink check.svg|pink
Purple check.svg|purple
Olive green check.svg|{{W|olive}}
image:Yellow check.svg|yellow
Cornflower blue check.svg|blue
Black check.svg|
White check.svg|white
Green check.svg|green
File:Red_check.svg|
Orange check.svg|{{W|orange}}
Light green check.svg|green
|w=96}}



0 the input is easy to read this way
0 (and does not need the 'format' parameter)

0 namespace ("file" or "image") won't disturb
0 but not so easy to read that way:

{{G|EU-section-with-A.svg|{{W|Austria}}|EU-section-with-BG.svg|{{W|Bulgaria}}|EU-section-with-CY.svg|{{W|Cyprus}}
|EU-section-with-CZ.svg|{{W|Czech}}|EU-section-with-D.svg|{{W|Germany}}|EU-section-with-DK.svg|{{W|Denmark}}
|EU-section-with-B.svg|{{W|Belgium}}|EU-section-with-EST.svg|{{W|Estonia}}|EU-section-with-FIN.svg|{{W|Finland}}
|EU-section-with-GR.svg|{{W|Greece}}|EU-section-with-IRL.svg|{{W|Irland}}|EU-section-with-SLO.svg|{{W|Slovenia}}|f=2|h=80|m=n}}
0 the description can also contain an URL
{{G|
Structural-Iceberg-ca.svg|{{Plainlinks|http://lightningvolt.com/Image%20Gallery/imagegallery.htm|URL 1}}
Structural-Iceberg-cs.svg|{{W|{{#language:cs}}}}
Structural-Iceberg.svg|{{Plainlinks|1=https://npgallery.nps.gov/AssetDetail/NRIS/1111|2=NRHP}}
Structural-Iceberg-ja.svg|{{#language:ja}}
|w=48|m=n}}

See also


Retrieved from "https://commons.wikimedia.org/w/index.php?title=Template:G/doc&oldid=702328546"