Template:Image frame/doc

From CivWiki
Jump to navigation Jump to search

__EXPECTED_UNCONNECTED_PAGE__

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

Page Template:TOC nonum/styles.css has no content.

Template parameters

Alignmentalign
"left" and "right" float the image to that side. "center" centres the image, and "none" left-aligns it without floating.
Default
right
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
Caption positionpos
Where to put the caption. Valid values: top, bottom.
Default
bottom
Inner frame styleinnerstyle
Plain CSS to apply to the inner frame. Use with care. Examples: text-align: center;, background: #ccc;.
Contentcontent
Content of the main section (generally images).
Borderborder
Border of the main section (generally images).
Default
yes
Link overridelinkoverride
Completely replaces the 'info' link.
Captioncaption
Modemode
Display mode of the main section, input scrollable will make the content scroling if the content is longer than viewport.
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%
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.

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