Template:Image frame

From electowiki
Template documentation[view] [edit] [history] [purge]
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage 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

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).
Default
Automatic, based on content
Numbersuggested
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
Borderborder
Border of the main section (generally images).
Default
yes
Contentoptional
Link overridelinkoverride
Completely replaces the 'info' link.
Lineoptional
CaptioncaptionContentoptional
Modemode
Display mode of the main section, input scrollable will make the content scroling 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
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).

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.

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).

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, input will make the content scroling 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

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