Template:Image frame/doc

Template page

This template creates a frame like those surrounding images. This template can be used to put two or more images into a frame together, or as a wrapper for more complicated templates like Template:Superimpose.

Template parameters

ParameterDescriptionTypeStatus
Contentcontent

Content of the main section (generally images).

Contentrequired
Widthwidth

The width of the image within the frame, in pixels (though do not add "px" to the width e.g., use width=175 and not width=175px).

Default
Automatic, based on content
Numbersuggested
Alignmentalign

"left" and "right" float the image to that side. "center" centres the image, and "none" left-aligns it without floating.

Suggested values
left center right none
Default
right
Stringoptional
Caption positionpos

Where to put the caption. Valid values: top, bottom.

Default
bottom
Stringoptional
Inner frame styleinnerstyle

Plain CSS to apply to the inner frame. Use with care.

Example
text-align: center;
Stringoptional
Linklink

Link for the "Enlarge" link in the caption (in the future, may also be used as the link for the image field inside the frame, though it would probably require an additional height parameter).

Page nameoptional
Alternative link textlink_text

Alternative text used for the link for the "Enlarge" link in the caption, usually displayed as tooltip.

Stringoptional
Link overridelinkoverride

Completely replaces the 'info' link.

Lineoptional
Captioncaption

no description

Contentoptional
Borderborder

Border of the main section (generally images).

Default
yes
Contentoptional
Modemode

Display mode of the main section, "scrollable" will make the content scrolling if the content is longer than viewport.

Stringoptional
Maximum widthmax-width

The maximum width of the image within the frame, in pixels (though do not add "px" to the width e.g., use max-width=350 and not max-width=350px), valid only in scrollable mode.

Default
100%
Numbersuggested
Directiondir

Use the value "rtl" to make the right side of the image the initial visible portion inside the scroll frame, valid only in scrollable mode.

Stringoptional
Stylestyle

Plain css to apply to the outer frame

Contentoptional

Examples

By filling out the parameters as follows, the result will be as shown below the code.

{{Image frame|width=200|content=[[File:PNG transparency demonstration 1.png|100px]][[File:White Stars 3.svg|100px]]
|caption=Example usage|link=Hello world|align=center}}
{{Image frame|width=200|content=[[File:PNG transparency demonstration 1.png|100px]][[File:White Stars 3.svg|100px]]
|caption=Example usage|link=Hello world|align=center|pos=top}}
{|
|-
|
{{Image frame|caption={{magnify icon|link=File:WW2-Holocaust-Europe.png}} Concentration-camp network of Nazi-occupied Europe.<br>Auschwitz is circled.|align=left
|content={{Superimpose
  | base = WW2-Holocaust-Europe.png
  | base_width = 300px
  | base_alt = Concentration-camp network in Nazi-occupied Europe
  | base_caption = Concentration-camp network in Nazi-occupied Europe
  | float = Red circle thick.svg
  | float_width = 20px
  | x = 171
  | y = 120
}}}}
|
# {{tl|Image frame}} to add frame and caption to a complex image made by {{tl|Superimpose}} — float [[File:Red circle thick.svg|20px]] on base [[File:WW2-Holocaust-Europe.png|100px]] 
# Manually add {{tl|magnify icon}} to caption to simulate the thumbnail icon [[File:Magnify-clip.svg|15px]]
# caption text won't auto-wrap to image width; you can add <br /> to prevent text overshooting. 
|}
Concentration-camp network of Nazi-occupied Europe.
Auschwitz is circled.
  1. {{Image frame}} to add frame and caption to a complex image made by {{Superimpose}} — float File:Red circle thick.svg on base File:WW2-Holocaust-Europe.png
  2. Manually add {{magnify icon}} to caption to simulate the thumbnail icon File:Magnify-clip.svg
  3. caption text won't auto-wrap to image width; you can add <br> to prevent text overshooting.
{{image frame|align=left|border=no|caption=A [[Help:Gallery tag|gallery]] in an image frame|content=
<gallery mode="packed">
Detroit Publishing Co. - A Yeoman of the Guard (N.B. actually a Yeoman Warder), full restoration.jpg
Official_program_-_Woman_suffrage_procession_March_3,_1913_-_crop.jpg
Thurston, the famous magician - East Indian Rope Trick.jpg
Joseph Ferdinand Keppler - The Pirate Publisher - Puck Magazine - Restoration by Adam Cuerden.jpg
</gallery>
}}
A gallery in an image frame

See also