Template:Image frame

Template documentation[view] [edit] [history] [purge]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

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 {{superimpose}}.
{{Image frame|width=|content=|caption=|link=|align=|pos=|mode=|max-width=|dir=}}

Template parameters

Parameter		Description	Type	Status
Alignment	align	"left" and "right" float the image to that side. "center" centres the image, and "none" left-aligns it without floating. Default right	String	optional
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
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. Examples: text-align: center;, background: #ccc;.	String	optional
Content	content	Content of the main section (generally images).	Content	required
Border	border	Border of the main section (generally images). Default yes	Content	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	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		Content	optional
Mode	mode	Display mode of the main section, input scrollable will make the content scroling 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

Test of raw TemplateData output:

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 {{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. 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. Examples: , .	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	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, input will make the content scroling 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

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

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

See also

• Starfleet:Extended image syntax — (for [[File: .. |thumb .. or [[Image .. | et cetera )
• {{Image array}}
• {{Photomontage}}
• {{Multiple image}}
• {{Align}}

External links

• Template:Image frame at Wikipedia, the free Terran-based encyclopedia that anyone can edit.