Template:Image frame

From Jonesipedia
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 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 Template:Superimpose.
{{Image frame |align= |mode= |width= |max-width= |style= |border= |pos= |link= |linkoverride= |link_text= |caption= |dir= |innerstyle= |content= }}

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
stylestyleContentoptional

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}}
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
{|
|-
|
{{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.
  1. {{Image frame}} to add frame and caption to a complex image made by {{Superimpose}} — float Red circle thick.svg on base WW2-Holocaust-Europe.png
  2. Manually add {{magnify icon}} to caption to simulate the thumbnail icon Magnify-clip.svg
  3. caption text won't auto-wrap to image width; you can add <br> to prevent text overshooting.

See also