Template:Image frame/doc

This is a documentation subpage for Template:Image frame.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 5,400 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

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}}

Example usage

{{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}}

Example usage

{|
|-
|
{{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 in Nazi-occupied Europe

Concentration-camp network of Nazi-occupied Europe.
Auschwitz is circled.

{{Image frame}} to add frame and caption to a complex image made by {{Superimpose}} — float on base
Manually add {{magnify icon}} to caption to simulate the thumbnail icon
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

Maintenance categories

Category:Pages using image frame with unknown parameters (37)

Templatedata

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Image frame in articles based on its TemplateData.

TemplateData for Image frame

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
Parameter		Description	Type	Status
Content	`content`	Content of the main section (generally images).	Content	required
Width	`width`	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	Number	suggested
Alignment	`align`	"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	String	optional
Caption position	`pos`	Where to put the caption. Valid values: top, bottom. Default bottom	String	optional
Inner frame style	`innerstyle`	Plain CSS to apply to the inner frame. Use with care. Example text-align: center;	String	optional
Link	`link`	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 name	optional
Alternative link text	`link_text`	Alternative text used for the link for the "Enlarge" link in the caption, usually displayed as tooltip.	String	optional
Link override	`linkoverride`	Completely replaces the 'info' link.	Line	optional
Caption	`caption`	no description	Content	optional
Border	`border`	Border of the main section (generally images). Default yes	Content	optional
Mode	`mode`	Display mode of the main section, "scrollable" will make the content scrolling if the content is longer than viewport.	String	optional
Maximum width	`max-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%	Number	suggested
Direction	`dir`	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.	String	optional
Style	`style`	Plain css to apply to the outer frame	Content	optional

Maintenance categories

Templatedata

See also