Template:F

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

Sample.svg

Documentation icon Documentationviewedithistorypurge

This documentation is transcluded from Template:F/doc.

Establishes a link to the file whose name is given in par #1 and displays the name without the prefix "File:".
Instead of the file name, any text given in par #2 can be displayed.
The file itself (the image) can be displayed at any size inline, after the name or left of it.

Additional possibilities:

  • It is possible to avoid the link and display the plain name of par #1 (or par #2).
  • It is possible to avoid any display of the name but display the image.
  • The displayed image can be surrounded by a border.

Beside of these standard usages exist extended possibilities, see below.

Usage

{{F |1= }}

The parameters "n" and "l" allow better formatting, e.g. to get equal-wide rows when arranging several lines with displayed images — see the two examples.

Template parameters

Parameter Description Default Status
1 file name: name of the file, with or without namespace
understrokes contained in the filename are replaced by spaces
empty required
2 display name: any text[1]. Default is the file name (par #1)
understrokes within the display name are displayed
empty optional
3 pixel size: numeric value. The picture is displayed inline in this size [2] empty optional
4 b[1] (lowercase B) to draw a border around the displayed picture empty optional
5 .l[1] (lowercase L) to display the image left of the file name empty optional
6 n[1] (lowercase N) to display the name not-linking to the file empty optional
7 Z[1] (uppercase Z) to suppress the display of the file name empty optional
8 File Function Letter[1][3]: different functions can be performed empty optional
t= any text string, used between displayed file name and displayed image   optional
l= language code (ISO 639), if the file is in another Wikipedia [2]
may specify e.g. "l=b:es" for an image of the Spanish Wikibooks,
or e.g. "l=s:it" for image Pallot1.svg in Italian Wikisource
empty optional
lang= language code (ISO 639), to display a translated version when
the SVG file contains translations using SVG <switch> elements.
empty optional

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

  • {{File|…}} – displays up to ten files: {{ Filefilename 1filename 2filename 3 }} with possibly other display names
  • {{Other}} – intended for usage in the Other field=

Examples

Standard usage

Syntax Code Example
{{ Ffile name }} {{F|SVG_Simple_Icon.svg}} SVG Simple Icon.svg is the simplest form; it displays the file name as a link to the file.
{{ Ffile nameany text }} {{F|SVG_Simple_Icon.svg|example}} example displays the text string of the 2nd parameter as a link to the file.
{{ Ffile name |  | size }} {{F|SVG_Simple_Icon.svg||16}} SVG Simple Icon.svgSVG Simple Icon.svg displays first the file name, and then the image in size px[2]
{{ Ffile nameany textsize }} {{F|SVG_Simple_Icon.svg|SVG|16x16}} SVGSVG Simple Icon.svg is the same but any text is displayed instead of the file name.

Extended usage

When with a "size" in parameter #3 the image display is requested, with the parameters b and l additional formatting can be performed.
The one-letter parameters can be specified in any sequence with every parameter #4 to #7 or #2, e.g 4=b and 6=l.

  • b draws a border around the image. This can be useful to show the extensions of the image.
  • l displays the image left of the name. This option allows a better formatting, e.g. when more files are displayed in a list and the file names are of different length.
    {{ Ffile name |  | sizel }} to display the file left of the name.
  • n: Independent whether the image is displayed or not, the parameter n let display plain text instead of the link. This is sometimes useful for better formatting.
Note: n can as well be specified with every parameter #4 to #7. When no display of the image is required, n can also be specified with parameter #3; when parameter #2 is not needed for a display text, n can even be specified with parameter #2 (to distinguish a text of one character from a one-character-code, the text may need to be expanded e.g. with <nowiki/>).
{{ Ffile nameany textsizebln }} is an example for usage of these formatting characters.
  • t=: When the image is displayed either left or right of the displayed file name, with t= any text can be defined to separate the two items. It will replace the default separator :&nbsp; (or &nbsp; with option l).
  • Z: When an image should be displayed without showing the file name, this can be achieved by setting the character "Z". Parameter #1 specifies the file name, parameter #3 the size; therefore Z can be set by either parameter #4 to #7 or the not needed parameter #2. Of course it is of no use to combine Z with l or n but it won't do any harm.
    E.g. the sequence {{ FSmall uppercase letter X.svgZ10b }}{{ FSmall uppercase letter X.svgb16Z }}{{ FSmall uppercase letter X.svgZ10b }} will show Small uppercase letter X.svgSmall uppercase letter X.svgSmall uppercase letter X.svg
{{F}} 0 no name without parameter #1: error display & categorization
{{F|Yes_check.svg}} Yes check.svg only link
{{F|Yes check.svg||n}} Yes check.svg only name
{{F|Yes check.svg||16|n}} 00 Yes check.svg: Yes check.svg no link (as in "other versions" of File:Arrow-C.svg.)
{{F|Yes check.svg||16|b}} Yes check.svgYes check.svg bordered
{{F|Yes check.svg||16|l}} Yes check.svg Yes check.svg 0 left of name (as in "other versions" of File:Symbol unrelated.svg.)

Language codes

The named parameter l= enables interwiki access. Files in any Wikipedia, Wikisource, Wikibooks etc can be addressed by a link, but it is not possible to display images from outside of Commons due to technical restrictions.

The named parameter lang= allows to use the language switch option:
The file France Population Pyramid-2010.svg contains many languages. With {{ FFrance Population Pyramid-2010.svg |  | 160lang = xx }} the translated versions can be shown:

arabicFrance Population Pyramid-2010.svg ivritFrance Population Pyramid-2010.svg koreanFrance Population Pyramid-2010.svg japanFrance Population Pyramid-2010.svg cyrillFrance Population Pyramid-2010.svg

File Function Letters

This option is completely different from the description above, a value is returned instead of displaying something. By invoking the Module:File various functions can be performed. While parameter #1 specifies the file, the File Function Letter must be specified with parameter #2 or #3. Such a FFL has precedence, additional parameter settings are ignored.
Except of the mere string operations F and X, for files outside the commons none of the File Functions can be performed.

FFL function returned result
0C count number of file pages
0D date work date, formatted
0F file name name without extension
0X extension extension without name
0I ifexist "true" if file exists
0S size file size in bytes
0H height height in pixel
0W width width in pixel
0V valid? error count from W3C validation
0P page size size of file description page in bytes

Example: Buddhist rainbow flag.svg file name: Buddhist flag (SVG file, nominally 450 × 300 pixels, file size: 625 bytes.)

Notes

  1. a b c d e f Parameter #1 can only hold the filename; an alternate text can only be passed with parameter #2, and the display-size only with parameter #3. Other codes are not fixed.
    Any of the codes (b, l, n, Z) can be passed in any sequence, each as an argument for one of the parameters either #2, #4, #5, #6 or #7: {{F|X.jpg||16|b|l|n}} is equivalent to {{F|X.jpg|n|16|l|b}}.
    "b", "l" or "n" may even be coded at the position of parameter #3 when no pixel size is specified there, or of parameter #2 when no text is passed.
    When it is required to display a text of one character equal to "b", "l", "n" or "Z" or a FFL it can be distinguished from such a code by an expansion, e.g. with <nowiki/>.
  2. a b c The size may be e.g. 96 or 60x16. It is not possible to display images of other Wikipedias - only when the files are stored in the Commons.
  3. A File Function Letter can be passed only with parameter either #2 or #3.