Template:Scalable image/doc

From MOASSpedia
Jump to navigation Jump to search

This template allows you to include a big image. If the image is too wide, the size of thumbnail frame will be smaller. If you do not want the image to use a thumbnail frame, you can use |border=no.

Usage

{{Scalable image|name|image width|caption|box width|alignment|alt=alt text}}
  • An image width option is required. This specifies the full width at which the image will be displayed, and is distinct from box width (the width of the box on the page).
  • A caption option is optional, and an image frame will be used if a caption is supplied. If the caption contains an equal sign, use the parameter |3=caption in the place of |caption. If the caption supplied is exactly equal to image syntax such as thumb, the image's tooltip will no longer display the caption, but instead default to the name of the image.
  • The box width option is optional, and if given a value in pixels followed by "px", or a value in percent followed by "%", will set the width of the box to that amount. For example, 45% would use 45% of the text section width, (not a percentage of the image width).
  • The alignment option is also optional but requires box width to be defined. If given a value of right or left, the entire wide image will float to the right or left. If given a value of none the image will not float.
  • The alt text describes the image's visual appearance to visually disabled readers. Please see WP:ALT for details.

To hide the tooltip, use |tooltip=no.

To align the caption, use |align-cap=.

To remove the outer border, use |border=no.

Example

Without caption

{{scalable image|Dew on grass Luc Viatour.jpg|2500px|
|alt=Dews on grass}}
Dews on grass

smaller

{{scalable image|Dew on grass Luc Viatour.jpg|500px|
|alt=Dews on grass}}
Dews on grass

With caption

{{scalable image|Dew on grass Luc Viatour.jpg|2500px|Dews on grass
|alt=Dews on grass}}
Dews on grass
Dews on grass

Without tooltip

{{scalable image|Dew on grass Luc Viatour.jpg|2500px|Dews on grass
|alt=Dews on grass
|tooltip=no}}
Dews on grass
Dews on grass

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Scalable image

Allows you to include a big image. If the image is too wide, the size of thumbnail frame will be smaller.

Template parameters

ParameterDescriptionTypeStatus
Filename1

Name of the file to display. Example: Dew on grass Luc Viatour.jpg

Stringrequired
Image width2

Give the width in pixels (like: 1600px) that you want the included image to be

Stringrequired
Caption3

A caption for the image that will be shown below image

Stringoptional
Width of frame4

Limit the width of the frame enclosing the picture. Example: "400px" or "40%"

Stringoptional
Frame alignment5

Either of: left, right, center or none. When specified also requires you to set the "Width of frame" option

Default
center
Stringoptional
Textual alternativealt

Describes the image's visual appearance to visually disabled readers. Please see WP:ALT for details

Stringoptional
Show tooltiptooltip

Use the value 'no' to make the tooltip of the image not shown inside the frame

Default
yes
Stringoptional

See also