Help:Images: Difference between revisions

From Monnier Group Research Wiki
Jump to navigationJump to search
m Help: namespace is not subpaged by default in most wikis, lets not make importing it too hard now.
 
m 1 revision
 
(No difference)

Latest revision as of 03:23, 27 February 2009

PD
PD
Important note: When you edit this page, you agree to release your contribution into the public domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages. See Project:PD help/Copying for instructions.
PD
PD

This page explains the image syntax when editing the wiki. Before using images in your page, your wiki must have file uploads enabled (see the technical manual for details) and you have to upload a file.

Syntax[edit]

The full syntax for displaying an image is:

[[File:{filename}|{options}]]

Where options can be zero or more of the following, separated by pipes:

  • border, frame, thumb, or frameless: Controls how the image is formatted
  • left, right, center, none: Controls the alignment of the image within a text
  • baseline, sub, super, top, text-top, middle, bottom, text-bottom: Controls the vertical alignment of the image within a text
  • {width}px: Resizes the image to the given width in pixels
  • {width}x{height}px: Resizes the image to fit within the given width and height in pixels; it is possible to specify only the height by writing x{height}px
  • Special cases:
    • page=1: Displays the specified page when showing a djvu file
  • link={destination}: Allows to link to an arbitrary title, URL or just nowhere (1.14+)
  • alt={alternative text}: For changing the alternative text (alt="") of an image (1.14+)

The options can be given in any order. If the given options conflict each other, the latter is applied, except for the format options, where the options take the priority in the order of frame, thumb, and frameless and/or border. If a given option does not match any of the other possibilities, it is assumed to be the caption text. Caption text can contain wiki links or other formatting.

Format[edit]

The following table shows the effect of all available formats.

Description You type You get
no format specified
... text text text
[[File:MediaWiki:Image sample|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|||caption]] text text text text text text text text text text text text text text text text text text text text text text text


border results in a very small gray border
... text text text
[[File:MediaWiki:Image sample|border|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|border||caption]] text text text text text text text text text text text text text text text text text text text text text text text


frame
... text text text
[[File:MediaWiki:Image sample|frame|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|frame||caption]] text text text text text text text text text text text text text text text text text text text text text text text


thumb
... text text text
[[File:MediaWiki:Image sample|thumb|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|thumb||caption]] text text text text text text text text text text text text text text text text text text text text text text text


frameless, like thumbnail, respect user preferences for image width but without border and no right float
... text text text
[[File:MediaWiki:Image sample|frameless|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|frameless||caption]] text text text text text text text text text text text text text text text text text text text text text text text


frameless and border
... text text text
[[File:MediaWiki:Image sample|frameless|border|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|frameless|border|caption]] text text text text text text text text text text text text text text text text text text text text text text text

When the height of an image in thumbnail is bigger than its width and you find it too outstanding, you may try the option upright, which will try to adjust its size to more desirable size.

Note that by writing thumb={filename}, you can use a different image for the thumbnail.

Alignment[edit]

Note that when using frame or thumb, the default alignment will be right.

Description You type You get
no alignment specified, or default alignment
... text text text
[[File:MediaWiki:Image sample|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|||caption]] text text text text text text text text text text text text text text text text text text text text text text text


specify alignment as none
... text text text
[[File:MediaWiki:Image sample|none|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|none||caption]] text text text text text text text text text text text text text text text text text text text text text text text


center
... text text text
[[File:MediaWiki:Image sample|center|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|center||caption]] text text text text text text text text text text text text text text text text text text text text text text text


left
... text text text
[[File:MediaWiki:Image sample|left|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|left||caption]] text text text text text text text text text text text text text text text text text text text text text text text


right
... text text text
[[File:MediaWiki:Image sample|right|caption]]
text text text ...

text text text text text text text text text text text text text text text text text text text text text text text [[File:MediaWiki:Image sample|right||caption]] text text text text text text text text text text text text text text text text text text text text text text text

Vertical alignment[edit]

text text [[File:MediaWiki:Image sample|20px]]
text text [[File:MediaWiki:Image sample|20px|baseline]]
text text [[File:MediaWiki:Image sample|20px|sub]]
text text [[File:MediaWiki:Image sample|20px|super]]
text text [[File:MediaWiki:Image sample|20px|text-top]]
text text [[File:MediaWiki:Image sample|20px|middle]]
text text [[File:MediaWiki:Image sample|20px|bottom]]
text text [[File:MediaWiki:Image sample|20px|text-bottom]]

results in (the text is underlined to show the result more clearly)

text text [[File:MediaWiki:Image sample|20px]] text text [[File:MediaWiki:Image sample|20px|baseline]] text text [[File:MediaWiki:Image sample|20px|sub]] text text [[File:MediaWiki:Image sample|20px|super]] text text [[File:MediaWiki:Image sample|20px|text-top]] text text [[File:MediaWiki:Image sample|20px|middle]] text text [[File:MediaWiki:Image sample|20px|bottom]] text text [[File:MediaWiki:Image sample|20px|text-bottom]]

Size and Frame[edit]

Among different formats, the effect of the size parameter may be different, as shown below.

  • When the format is not specified, or only bordered, the size can be both reduced and enlarged.
  • A image with frame always ignores the size specification.
  • The size of an image with thumb and frameless can be reduced, but can not be enlarged beyond the original size of the image.

For how it appears when its size is not specified, see Format section above.

Format Reduced Enlarged
(not specified)
[[File:MediaWiki:Image sample|50px]]

[[File:MediaWiki:Image sample||50px]]

[[File:MediaWiki:Image sample|500px]]

[[File:MediaWiki:Image sample||500px]]


border
[[File:MediaWiki:Image sample|border|50px]]

[[File:MediaWiki:Image sample|border|50px]]

[[File:MediaWiki:Image sample|border|500px]]

[[File:MediaWiki:Image sample|border|500px]]


frame
[[File:MediaWiki:Image sample|frame|50px]]

[[File:MediaWiki:Image sample|frame|50px]]

[[File:MediaWiki:Image sample|frame|500px]]

[[File:MediaWiki:Image sample|frame|500px]]


thumb
[[File:MediaWiki:Image sample|thumb|50px]]

[[File:MediaWiki:Image sample|thumb|50px]]

[[File:MediaWiki:Image sample|thumb|500px]]

[[File:MediaWiki:Image sample|thumb|500px]]


frameless
[[File:MediaWiki:Image sample|frameless|50px]]

[[File:MediaWiki:Image sample|frameless|50px]]

[[File:MediaWiki:Image sample|frameless|500px]]

[[File:MediaWiki:Image sample|frameless|500px]]

Gallery of images[edit]

It's easy to make a gallery of thumbnails only, not other images, with the <gallery> tag. The syntax is:

<gallery>
File:{filename}|{caption}
File:{filename}|{caption}
{...}
</gallery>

Note that the image code is not enclosed in brackets when enclosed in gallery tags.

Captions are optional, and may contain wiki links or other formatting.

for example:

<gallery>
File:MediaWiki:Image sample|Item 1
File:MediaWiki:Image sample|a link to [[Help:Contents]]
File:MediaWiki:Image sample
File:MediaWiki:Image sample
File:MediaWiki:Image sample| ''italic caption''
File:MediaWiki:Image sample|on page "{{PAGENAME}}"
</gallery>

is formatted as:

Parameters[edit]

The gallery tag itself takes several additional parameters:

<gallery {parameters}>
{images}
</gallery>
  • caption={caption}: sets a caption on the gallery.
  • widths={width}px: sets the widths of the images.
  • heights={heights}px: sets the (max) heights of the images.
  • perrow={integer}: sets the number of images per row.

Link to description page[edit]

If you put a colon (:) before File:, the image will not be embedded and the link will lead to the description page of the file.

[[:File:MediaWiki:Image sample]]
[[:File:MediaWiki:Image sample|Sunflowers]]

results in

[[:File:MediaWiki:Image sample]] [[:File:MediaWiki:Image sample|Sunflowers]]

Link directly to file[edit]

You can use the pseudo-namespace “Media” to link directly to a file, bypassing the description page.

[[Media:MediaWiki:Image sample]]
[[Media:MediaWiki:Image sample|Sunflowers]]

results in

[[Media:MediaWiki:Image sample]] [[Media:MediaWiki:Image sample|Sunflowers]]

Files at other websites[edit]

You can link to an external file using the same syntax used for linking to an external web page.

[http://url.for/some/image.png]

Or with different text:

[http://url.for/some/image.png link text here]

If it is enabled on your wiki (see Manual:$wgAllowExternalImages), you can also embed external images. To do that, simply insert the image's url:

http://url.for/some/image.png

See also[edit]