Extended image syntax

From Mount Wiki

Jump to: navigation, search

Contents

Introduction

In brief, the syntax for displaying an image is:

[[File:{name}|{type}|{location}|{size}|{upright}|{border}|{caption}]]

Only [[File:{name}]] is required. Most images should use [[File:{name}|thumb|Example image caption]] (and should not specify a size). 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. Defaults to 'right'.
Size 
{width}px or {width}x{height}px, scales the image to be no greater than the given width and height, keeping its aspect ratio.
Upright 
for use only on images that are taller than they are wide. This scales the image differently, considering both width and height instead of only width. A parameter can be added to adjust the size: for instance "upright=1.5" will make the image larger, useful for maps or schematics that need to be larger to be readable.
Border 
adds a border around the image
Caption 
Any element which cannot be identified as one of the above is assumed to be caption text.

Detailed syntax

Type

  • "thumbnail" or "thumb": Image is scaled down to a standard, user specified width, by default 180 pixels, and a box is added around the image. If a caption is written, it is shown below the image. Image defaults to placement on the 'right' unless overridden with the 'Location' attribute (see above).
  • "frame": Original image size is preserved, and a box is added around the image. If a caption is written, it is shown below the image.
  • (nothing specified): Original image size is preserved, no border is added around the image. If a caption is written, it is not shown.
  • "border": Same as if nothing is specified, but a border is added around the image.

Location

  • "right": Image including its box is placed on the right side of the page. The article text that follows the image flows around the image.
  • "left": Image including its box is placed on the left side of the page. The article text that follows the image flows around the image.
  • "center": Image including its box is placed in the center of the page. The article text that follows the image is placed below the image.
  • "none": Image including its box is placed on the left side of the page. The article text that follows the image is placed below the image.

Size

  • "100px": Scales the image down to make it 100 pixels wide. Replace any number for 100. If you specify "thumbnail" and a value here, this value will take precedence. If the image is already smaller than your specified value, the image stays at its size.
  • "100x200px": Scales the image to be no wider than 100 pixels and no higher than 200 pixels. Image will keep its original aspect ratio.
  • (nothing specified): Uses the size specified in preferences for logged in users, uses a size determined by resolution for anonymous users.

Caption

Any element which cannot be identified as one of the above is assumed to be caption text.

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

To use an image as uploaded with a caption use [[File:Strahlhorn.jpg|frame|none|caption text]]. This is the syntax you should use.

caption text

New syntax for images

The Strahlhorn

In the syntax [[File:filename|options]] (e.g. [[File:Strahlhorn.jpg|thumb|100px|left|The Strahlhorn]] 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.

The Strahlhorn
  • The options can be combined, and vertical bars ("|") are used to separate options from each other.
  • Do not put spaces around the vertical bars for readability – options will not be interpreted correctly.
  • The options can be put in any order.
  • An unknown option is taken as the caption text, but this will appear only if thumbnail or frame are specified.
  • If there are two or more unknown options, the last one upstages the rest: [[File:Strahlhorn.jpg|thumb|The Palace of Westminster|200px|right|Strahlhorn]] (shown on the right).

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

right 
The image is right-aligned, and text floats to the left of the image: [[File:Strahlhorn.jpg|right|70px|]] (shown on the right).
left 
The image is left aligned, and text floats to the right of the image: [[File:Strahlhorn.jpg|left|70px|]] (shown on the left).
center 
The image is centered, and...
the text following the image starts below it: [[File:Strahlhorn.jpg|center|70px|]] (shown above).
none 
The image is put at the left, and...
the text following does not float to the right (or to the left, obviously), and starts below it: [[File:Strahlhorn.jpg|none|70px|]] (shown above).
Notes:
The above four options are incompatible. When used combined, the first one overrides the rest: [[File:Strahlhorn.jpg|center|left|none|right|70px|]] (shown in the center).
What 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: [[File:Strahlhorn.jpg|70px|right]] (shown on the right).
This text is displayed.
In 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: [[File:Strahlhorn.jpg|thumb|This text is not displayed.|70px|left|]] (shown on the left) and [[File:Strahlhorn.jpg|thumb|This text is displayed.|70px|right]] (shown on the right).
sizepx 
This option renders a version of the image that's [size] pixels wide (e.g. [[File:Strahlhorn.jpg|right|50px|]] shown on the right). Height is computed to keep aspect ratio (i.e. the shape of the image)
Notes:
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.
This means the server does all the work of changing the image size, not the web browser of the user. By having the server do all the work means faster downloading of pages. It also means that larger images can be stored on the server without any slowdown by the browser (especially on dial up telephone lines.) Only the data for the actual size on the page is transmitted.
From MediaWiki 1.5 the default thumbnail width can be set in the preferences, so it is recommended not to specify "px", in order to respect the users' preferences (unless, for a special reason, a specific size is required regardless of preferences, or a size is specified outside the range of widths 120–300px that can be set in the preferences).
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
When there are two or more "size" options, only the last one is valid: [[File:Strahlhorn.jpg|right|50px|80px]] (shown on the right).
thumbnail, thumb 
The Strahlhorn
The 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. [[File:Strahlhorn.jpg|thumbnail|left|100px|]] (shown on the left) and [[File:Strahlhorn.jpg|thumb|The Strahlhorn]] (shown on the right). Note: thumbnail (thumb) cannot be used in lists.


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

text text text text text text
[[File:Strahlhorn.jpg|150px|The Strahlhorn]]
text text text text text
[[File:Strahlhorn.jpg|10px|The miniature Strahlhorn]]
text text text text

gives

text text text text text text The Palace of Westminster text text text text text The miniature Strahlhorn 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:

Mountains you should climb in Switzerland
Strahlhorn
Strahlhorn
[[File:Strahlhorn.jpg|thumb|none|100px|Strahlhorn]]
Rimpfischhorn [[[File:Rimpfischhorn.jpg|thumb|none|100px|Rimpfischhorn]]

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.:

[[File:Rimpfischhorn.jpg|thumb|none|100px|Rimpfischhorn in the [[Mischabel]]massif]]


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.

Additional caption formatting options

Additional caption formatting options are possible.

[[File:Strahlhorn.jpg|right|thumbnail|<div align="center">This is <span style="color: green">the </span><br /> [[Strahlhorn]]<br /> '''in <span style="color: red">Switzerland</span>'''</div>]]

This is the
Strahlhorn
in Switzerland


All of the normal text formatting options 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:

File:Stralhorn.jpg
{| align="right"
| [[File:Strahlhorn.jpg|160px|Example]]
|}

This code is not intended for general use, however. There are few, if any, instances where support for such legacy browsers is necessary.

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 {{-}} in certain namespaces (En, meta).

Image galleries

Personal tools
Writing an article
Social links
Translate
Sponsors