Template:Image frame

From Hârn
Jump to navigation Jump to search
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=}}

Template parameters

ParameterDescriptionTypeStatus
Alignmentalign
"left" and "right" float the image to that side. "center" centres the image, and "none" left-aligns it without floating.
Default
right
Stringoptional
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)
Numberrequired
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. Examples: text-align: center;, background: #ccc;
Stringoptional
Contentcontent
Content of the main section (generally images)
Contentrequired
Link overridelinkoverride
Completely replaces the 'info' link.
Lineoptional
CaptioncaptionContentoptional
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

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)

Numberrequired
Alignmentalign

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

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

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)

Pageoptional
Link overridelinkoverride

Completely replaces the 'info' link.

Lineoptional
Captioncaption

no description

Contentoptional

Examples[edit source]

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}}
PNG transparency demonstration 1.pngWhite Stars 3.svg
Desc-i.svg
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}}
Desc-i.svg
Example usage
PNG transparency demonstration 1.pngWhite Stars 3.svg

See also[edit source]

External links[edit source]