Template:G/doc: Difference between revisions

|2def    =1{{0|0}}[[#Defaulting the "format"|(or '''2''')]]

|3d      =gallery mode, can be specified with <br />{{T\|<code>t</code>}} or {{T\|traditional}}<br />{{T\|<code>n</code>}} or {{T\|nolines}}, <br />{{T\|<code>p</code>}} or {{T\|packed}},<br />{{T\|<code>h</code>}} or {{T\|packed-hover}}, <br />{{T\|<code>o</code>}} or {{T\|packed-overlay}}, <br />{{T\|<code>s</code>}} or {{T\|slideshow}}  <br />when parameter <code>format</code> is not specified, <code>nolines</code> is defaulted,<br />but that defaulting can be avoided with an empty mode parameter <code>m=</code>

|3def    =<br /><br /><br /><span style="color:#777;font-variant:small-caps">empty</span><br /><br /><br /><br /><br />nolines

|desc-en={{Lua|Module:Galeria}}Displays a gallery of files, {{Nobold|using just the conventional <code><nowiki><gallery></nowiki></code> tag,<br />but with shorter parametrizing and some useful defaults.}}

<div style="float:left;padding-right:2em;width:24%">{{Nobold|__TOC__}}</div><br /><br />{{Nobold|Such a gallery can contain one file or more, up to an unlimited number:}}<br /><br />

* {{Nobold|with just {{Tle|T=G|filename}} a 'gallery' of a single file can be shown,}}<br /><br />

* {{Nobold|with e.g. {{Tle|T=G|filename1|filename2| ... }} more files are displayed.}}<br /><br />

{{Nobold|The display format can be influenced by several additional options.}}

 

|namespace=File

|usage-notes=

|type=

|i18n-desc=

|seealso=The (reduced) [[Template:F#Gallery_style|Gallery Function]] of {{T|F|-}}<br />Another solution: {{T|Gallery|-}} and {{T|Gallery items}}<br />

On meta: [[m:Help:Images and other uploaded files#Gallery]]<div style="background-color:#dfd;width:60%;">

Some {{C|Lua-based iteration templates}} have an option to invoke the gallery function; mainly the templates<br />{{T0|Derivative versions}} and {{T0|Other versions}}, as well as {{T0|Filelist}} and {{T0|File}} can invoke either one of {{M|Iteration}} or {{M|Galeria}}.<br />

For easy switching between both modules, their shortcode character parameters [[Module talk:Galeria/doc|won't conflict]].</div><br />

|setscats=

|lines=

 

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

== The parameter "format" ==

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

<div style="background-color:#cfc;width:52%;"><u>Note:</u> 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.</div>  

When format ''and'' width ''and'' mode are missing, <code>mode</code> becomes defaulted with <code>nolines</code>.  

=== Defaulting the  "format" ===

This parameter is a necessary addition to the parameters used by <code><nowiki><gallery></nowiki></code>.<br />

When the most frequent invocation form for <nowiki><gallery></nowiki> is used, i.e.

the display with <nowiki>{{G| ... }}</nowiki> is the almost same as with <nowiki><gallery> ... </gallery></nowiki>.<br />

<div style="background-color:#fe9;width:52%">{{0|MWMWMWM}}<u>Be aware:</u> There are other valid possibilities to specify the parameters;

::::but ''only the form as described above'' will result in the "format" defaulting.</div>  

== File list notations ==

;List 1: {{tle|T=G|file1.ext|file2.ext|...|file{{sub|n}}.ext|more parameters}}

;List 2:  {{tle|T=G|<br />file1.ext<br />file2.ext<br />...<br />file{{sub|n}}.ext<br />|more parameters}}

<div style="background-color:#cfc;width:60%;">The file names ("items") are specified with unnamed parameters.<br />

Each unnamed parameter (p{{sub|1}} to p{{sub|∞}}) can contain an '''unlimited number''' of linefeed-separated items.<br />

(See also the [[Template talk:G#Item separation|overview]]). </div>

;List 3:  {{tle|T=G|file1.ext|description1|file2.ext|description2|...|file{{sub|n}}.ext|description{{sub|n}}|p8=&nbsp;f|2|more parameters}}

<div style="background-color:#cfc;width:60%;">For <code>format=2</code> care should be taken when defining the items; it does not matter <br />whether they are pipe-separated or linefeed-separated, but ''file names'' are defined with item{{sub|1}}, item{{sub|3}}, item{{sub|5}}, ... <br />while the descriptions are defined with the corresponding  item{{sub|2}}, item{{sub|4}}, item{{sub|6}}, ...<br />

Description items can be specified empty, but file name items ought to contain a value.</div>

:{{tle|T=G|<br />file1.ext | name1<br />file2.ext | name2<br />...<br />| more parameters}}

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

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

|}</pre>

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

{| class="wikitable"}}

|-

|style="width:60%"|{{G|

Example.png}}  ||{{0}} <small>just one file without option parameters</small><br /><br /><nowiki>{{G|

Example.png}}</nowiki> <br /><br /><br /><small>That image can as well be obtained with</small><br /><nowiki><gallery mode="nolines" showfilename="yes"></nowiki><br /><nowiki>Example.png</gallery></nowiki>  

|-

|{{0}} <small>some files, without option parameters</small><br /><br /><br /><br /><nowiki>{{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}}</nowiki>

|-

|f=0|w=48|m=n|c=eight smileys &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp;}} || <pre>{{G|Day-template.svg

|c=eight smileys &amp;emsp; &amp;emsp;|f=0|w=48|m=n}}</pre>

|-  

|f=0|w=80|p=4|a=c}} || {{0}} <small>globally centered with </small> <code>a=c</code><br /><br /> <pre>

{{G|Blue king.svg|Chess kgt45.svg

|f=0|w=80|p=4|a=c}}</pre>

|-

|{{0}} <small>Some descriptions are missing</small> <br /><br /><br /><br /><pre>

|w=96}}</pre><br /><br /><br />{{0}} <small>the input is easy to read this way</small><br />{{0}} <small>(and does not need the 'format' parameter)</small><br /><br />{{0}} namespace ("file" or "image") won't disturb

|-

|{{0}} <small>but not so easy to read that way:</small><br /><br /><pre>{{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-GR.svg|{{W|Greece}}|EU-section-with-IRL.svg|{{W|Irland}}|EU-section-with-SLO.svg|{{W|Slovenia}}|f=2|h=80|m=n}}</pre>

|-

|style="width:22%"|{{G|

|w=48|m=n}}           ||style="width:78%"|{{0}} <small>the description can also contain an</small> URL<br /><pre>{{G|

|w=48|m=n}}</pre>