Template:File

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

[edit subpage]

This template in most cases is transcluded with one file, but it is able to display an unlimited number of files.
This template finally uses Template:F, which can be customized with many parameters.
Two kinds of parameters can be used for that customizing:

  1. global parameters, which are valid for each file, as long they are not suppressed or overriden by
  2. individual parameters, which are valid for only one of the files, whose number is specified.

A parameter is either specified (with a value), or not (when not coded, or without a value).
Specified global parameter values can be individually

  • kept valid, by not specifying an individual parameter
  • suppressed, with an individual value specified empty
  • overriden, by an individual value specified

An empty specified individual parameter for a not specified global parameter is useless but will not disturb;
an individual parameter with a number exceeding that of the specified files is useless but will not disturb.
Some parameters format the file display layout; when no display occurs, their specification is useless but will not disturb.

Display other files

Usage

{{File |1= }}

Template parameters

ParameterDescriptionDefaultStatus
1File name of the image (with or without namespace).0optional
2, 3, ... nnames of more files; for each empty parameter, the name of parameter 1 is usedemptyoptional
labFFF or l
0l1 ... ln
(Global display label for files) normally not useful if more than 1 file
individual parameter(s)
emptyoptional
disFFF or dl
0d1 ... dn
Global pixel size value, to display the image. See also the parameter "z"
individual size parameter{s}
emptyoptional
optFFF or o
0o1 ... on
Global additional option for {{F}}, like "l" (left) or "b" (bordered)
individual option(s)
emptyoptional
par4FF or ql
0q1 ... qn
Global 4th parameter for {{F}}, like "n" (nolink) or "+" or "-"
individual more parameter(s)
emptyoptional
par5FF or rl
0r1 ... rn
Global 5th parameter for {{F}}
individual more parameter(s)
emptyoptional
wikiFF or kl
0k1 ... kn
Global ISO 639-1 code for a Wikipedia sisterproject
individual code parameter(s)
emptyoptional
interF or il
0i1 ... in
Global ISO 639-1 code for SVG switch internationalization
individual code parameter(s)
emptyoptional
pfxFFF or xl
0x1 ... xn
Global code prefixing the file
individual prefix parameter(s)
emptyoptional
t1 ... tnindividual postfix text parameter(s) (does not exist globally)emptyoptional
byFFFF or bl
0b1 ... bn
Global author name
individual author name(s)
emptyoptional
modFFF or ml
0m1 ... mn
Global code for modification of the user link(s)
individual modifications (as t, w, wt)
emptyoptional
conjFF or cspecify c[on[j]]=n to suppress the commas and the final 'and' in the listemptyoptional
varyFF or vla parameter list for variations is usedemptyoptional
v1FFF and v2lGlobal pre- and postfixes for variationsemptyoptional
spaFFF or sl
0s1 ... sn
Global code for an intermediate space for variations: "+" for a space, else none
individual codes
emptyoptional
galleryset to "yes" for a gallery layout: see {{G}} for gallery parameters
The characters for the individual parameter codes won't conflict with them for galleries.
emptyoptional

Additional information

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

The template is intended to be used by the following user groups: no user group specified

See also

There are currently five templates creating file lists with the function:filelist of the Module:Iteration

  1. Other versions a vertical list (without initial)
  2. Derivative versions a vertical list
  3. Derived from a vertical list
  4. Filelist a horizontal list (without initial)
  5. File a horizontal list

All these templates are autoreferencing, and they support also the "gallery" option.


Example

{{ Filea.pngb.png }} will give 0

Files: A.png and B.png

{{ Filea.pnge.png }} will give 0

File: A.png, A.png, A.png, A.png and E.png

{{ Filea.pnge.png× }} will give 0

Abbreviation

In simple cases the |by= can be abbreviated with /:
{{ FileExample.jpg/Exampleexample.svg/Extra }}
renders as

Files: Example.jpg by Example and Example.svg by Extra

Pseudo filenames

Normally the parameters 1 ... n specify file names. Some special functions are performed with parameters not specifying real file names;
but all parameters are counted, regardless whether they are real filenames or not. With e.g. the pseude filename "×" at the last position the and can be converted to a ,.

Display text

When a parameter is specified starting and ending with " (" sign ") the text between the two quotes is displayed.

Variations

are a function for series of files with names differing only in one part, as it should be in well designed file systems; see the three examples below.
The variation option is triggered with the parameter "vary" or "v" specifying the pattern that should be replaced.

  • The first file name parameter is not a real file name, it contains the pattern which will be replaced by the following strings.
  • All the other file name parameters are not real file names but the strings replacing the pattern; an empty parameter just removes the pattern.

Specially for variations (but not only) the shortcut parmeter "z" is useful: it specifies the display size (like "d"),

and sets in addition the "o=Z" and "p= ", when they are not specified otherwise: a |p= specification overwrites the |z= option:

default
p=­ ­­­­­­­
p=   

Variations: single replacements

Each parameter (except the first one) is combined with the first parameter to generate an existing filename.

Example: {{ Filevary = ?z = 48Pictogram reply?.svg"Replies: "bluegreensoft green }}
Files: Replies:

Variations: loop replacements

For series of files where the variated part is a number, it is possible to specify in one parameter the starting and the ending number, to generate all the file names - without any limit.
Loop replacements are specified with a parameter starting with a "#", followed by the first number, another "#" follwed by the second number and ending with another "#".
The second number (the upper limit) must not be less than the first number (the lower limit). When any error occurs, no looping is done.

Example: {{ Filev = xxz = 20State Highway xx NZ.svg"  1st: "#1#8#"  2nd: "#20#41#"  3rd: "#56#60# }}
Files:   1st:
  2nd:
  3rd:


In such a way, hundreds of files can be displayed with few parameters, e.g. {{ Flv = #z = 12Bundesstraße # number.svg#1#113# }}
113 Bundesstraßen:


Syntax
{{ Filefilename 1filename 2filename 3... }} unlimited, with possibly some other display names:
{{ Filefilename 1filename 2filename 3...l1 = displayname 1l2 = displayname 2...l23 = displayname 23 }}
Parameters
  • {{ FileRed.svgd = 14 }} →
File: Red.svg
  • {{ FileRed.svgSolid blue.svg }} →
  • {{ FileRed.svgSolid blue.svgSolid yellow.pngd2 = 12 }} →
  • Etc., parameters without any limit.
  • {{ FileAugsburg Tram 1.svgAugsburg Tram 2.svgAugsburg Tram 3.svgAugsburg Tram 4.svgn2 = № 2n3 = № 3n4 = № 4 }} →