Wikipedia:Extended image syntax

From Free net encyclopedia

{{{1{{{1|}}}|

Shortcut:
{{{1|}}}
}}}

In brief, the syntax for displaying an image is:

[[Image:{name}|{type}|{location}|{size}|{caption}]]

Only [[Image:{name}]] is required. The other details are optional and can be placed in any order.

Type 
'thumb' / 'thumbnail' or 'frame'. Causes image to be displayed with specific formatting (see below).
Location 
'right', 'left', 'center' or 'none'. Determines placement of the image on the page.
Size 
{width}px (e.g. 50px), scales the image to the given width, keeping its aspect ratio.
Caption 
Any element which cannot be identified as one of the above is assumed to be caption text.

Contents

Syntax to use an image in uploaded size, with a caption

To use an image as uploaded with a caption use [[Image:Westminstpalace.jpg|frame|none|caption text]]. This is the syntax you should use to update images that used the original image markup of the form [[Image:Westminsterpalace.jpg|caption]].

Image:Westminstpalace.jpg

Syntax for images with no automatic caption or formatting

The old syntax for images without captions is [[Image:Westminstpalace.jpg|alt text]]. This is rendered inline, and the specified text is used as the image's alt attribute (alternate text for programs which cannot display images, such as screen readers) and as the title attribute (supplementary text, often displayed as a tool tip when the mouse is over the image).

See Wikipedia:Image markup with HTML for an old, deprecated, way of putting a caption under the image using HTML code. Please use the new way of associating captions with images, as described on this page.

See Wikipedia:Captions for discussion of appropriate caption text. See Wikipedia:Alternative text for images for discussion of appropriate alt text. Unfortunately, it is not possible to specify different text for these two purposes.

Example

Image:Westminstpalace.jpg

New syntax for images

Image:Westminstpalace.jpgThe new syntax is backward compatible, so articles don't have to be changed. In the syntax [[Image:filename|options]] (e.g. [[Image:Westminstpalace.jpg|thumb|100px|left|The Palace of Westminster]] shown in the left), several options can be set when including an image. Those affect the placing of the image, its size or the way the image will be presented. The options are right, left, center, none, sizepx, thumbnail (thumb), frame, and alternate (caption) text.

  1. redirect Template:-

Image:Westminstpalace.jpg The options can be combined, and vertical bars ("|") are used to separate options from each other. The options can be put in any order. An unknown option is taken as the caption text. If there are two or more unknown options, the last one upstages the rest: [[Image:Westminstpalace.jpg|thumb|The Palace of Westminster|200px|right|From the Thames]] (shown on the right).

  1. redirect Template:-

Here is the description of the options other than the caption text:

right 
Image:Westminstpalace.jpgThe image is right-aligned, and text floats to the left of the image: [[Image:Westminstpalace.jpg|right|70px|]] (shown on the right).
  1. redirect Template:-
left 
Image:Westminstpalace.jpgThe image is left aligned, and text floats to the right of the image: [[Image:Westminstpalace.jpg|left|70px|]] (shown on the left).
  1. redirect Template:-
center 
The image is centered, and...Image:Westminstpalace.jpgthe text following the image starts below it: [[Image:Westminstpalace.jpg|center|70px|]] (shown above).
  1. redirect Template:-
none 
The image is put at the left, and...Image:Westminstpalace.jpgthe text following does not float to the right (or to the left, obviously), and starts below it: [[Image:Westminstpalace.jpg|none|70px|]] (shown above).
  1. redirect Template:-


Notes:
  1. redirect Template:-
Image:Westminstpalace.jpgThe above four options are incompatible. When used combined, the last one overrides the rest: [[Image:Westminstpalace.jpg|none|right|center|left|70px|]] (shown on the left).
  1. redirect Template:-
Image:Westminstpalace.jpgWhat is between the last vertical bar and the closing brackets ("]]"), void or not, is taken as the last option, and works as usual. For instance, when the last option is right, the image is right-aligned, and text floats to the left: [[Image:Westminstpalace.jpg|70px|right]] (shown on the right).
  1. redirect Template:-
Image:Westminstpalace.jpgImage:Westminstpalace.jpgIn particular, if the last option is the void text (that is, if there is nothing between the last vertical bar and the closing brackets), the caption is not displayed: [[Image:Westminstpalace.jpg|thumb|This text is not displayed.|70px|left|]] (shown on the left) and [[Image:Westminstpalace.jpg|thumb|This text is displayed.|70px|right]] (shown on the right).
  1. redirect Template:-
sizepx 
Image:Westminstpalace.jpgThis option renders a version of the image that's [size] pixels wide (e.g. [[Image:Westminstpalace.jpg|right|50px|]] shown on the right). Height is computed to keep aspect ratio (i.e. the shape of the image)
  1. redirect Template:-
Notes:
  1. redirect Template:-
Specifying a size does not just change the apparent image size using HTML; it actually generates a resized version of the image on the fly and links to it appropriately. This happens whether or not you use size in conjunction with thumb.
Template:H:new
If you specify a "frame" option the image will not be scaled, and no size specifiers will be in the HTML. The image will be rendered at full size
  1. redirect Template:-
Image:Westminstpalace.jpgWhen there are two or more "size" options, only the last one is valid: [[Image:Westminstpalace.jpg|right|50px|80px]] (shown on the right).
  1. redirect Template:-
thumbnail, thumb 
Image:Westminstpalace.jpgImage:Westminstpalace.jpgThe thumbnail (thumb) option generates a thumbnail image. It is automatically resized when the "size" attribute is not specified. Without the options left, center, and none, the image is normally on the right. If the image has a caption text, it is displayed in the lower margin. E.g. [[Image:Westminstpalace.jpg|thumbnail|left|100px|]] (shown on the left) and [[Image:Westminstpalace.jpg|thumb|The Palace of Westminster]] (shown on the right).
  1. redirect Template:-

Image:Tst.pngAn "enlarge"-icon is put also in the lower margin of the thumbnail. Both the image itself and the icon link to the image description page with the image in its actual size. The icon shows the link title "Enlarge" in its hoverbox, even in cases where this term does not apply, because it leads from the enlarged image to the one with the actual size. E.g. [[Image:tst.png|right|thumb|100px|This is a globe, and take a look at it in [[Media:tst.png|the actual size]].]] (shown on the right).

  1. redirect Template:-
frame 
Image:Westminstpalace.jpgWith this option, the embedded image is shown with its actual size enclosed by a frame, regardless of the "thumb" or "size" attribute, and the caption, if any, is visible in the frame. Without the options left, center, and none, the image is normally on the right: [[Image:Westminstpalace.jpg|frame|thumbnail|50px|The Palace of Westminster]].
  1. redirect Template:-

With none of the options other than sizepx and alternate (caption) text, an embedded image is rendered inline.

text text text text text text
[[Image:Westminstpalace.jpg|150px|The Palace of Westminster]]
text text text text text
[[Image:tst.png|100px|This is a globe.]]
text text text text

gives

text text text text text text Image:Westminstpalace.jpg text text text text text Image:Tst.png text text text text

The option none can be used to have thumbnails without left- or right-alignment. This is probably most useful for tables. This is an example:

How to use none
London's palaces
Palace of Westminster Image:Westminstpalace.jpg [[Image:Westminstpalace.jpg|thumb|none|100px|From the Thames]]
Buckingham Palace Image:Buckingham palace Copyright2003KaihsuTai.jpg [[Image:Buckingham palace Copyright2003KaihsuTai.jpg|thumb|none|100px|Queen's home]]

Thumbnail with caption text underneath that has one or more links

From MediaWiki 1.3, it is also possible to include links in the caption text, e.g.:

[[Image:Westminstpalace.jpg|right|thumbnail|This is the [[Palace of Westminster]] in London]]

Image:Westminstpalace.jpg


Just make sure the number of opening and closing square brackets are right. One extra or missing would mean the entire image syntax line would not work.

Compatibility considerations

The floating options left, center, and right explained above are supported by modern browsers, but have unfortunately no effect with legacy browsers. If necessary it's simple to get a floating effect also for old browsers, example for an image floating right:

Image:Clear1x1.gif
Source Wiki markup:
{| align="right"
| [[image:clear1x1.gif|160px|transparent example]]
|}

A floating align="right" (dito left) table is not the design sin known as table layout, it merely emulates what <div> and CSS do today in an admittedly verbose way for old browsers.

Cancelling floating-around-image mode

After having had an image floating next to text, putting further text below it and again using the full width can be done with the following markup. This blocks an image from appearing next to the material following this markup, possibly due to aesthetic reasons or a change in topics.

<br style="clear:both" />

For legacy align="right" (etc.) floating this isn't good enough, legacy browsers would ignore inline CSS. To cancel floating under all conditions the following markup (valid XHTML 1.0 transitional) works:

<br clear="all" />

The same code can be issued by using template {{Clr}} in certain namespaces (En, meta).

Linking to the image description page

If you want to make a link to the description page for an image, use a leading colon before "image:" in an intra-wiki link, like this: [[:image:STS-32 crew.jpg|STS-32 crew]] which yields: STS-32 crew

Image galleries

See Wikipedia:Gallery

See also

es:Wikipedia:Cómo se añaden imágenes fr:Wikipédia:Description d'une image it:Aiuto:Markup immagini nl:Help:Gebruik_van_afbeeldingen sv:Wikipedia:Bildmallar ur:تصویروں کا استعمال کیسے کریں