Template:Plain image with caption/doc View history

Revision as of 07:14, 30 September 2015 by Kentsmith9 (talk | contribs) (Added doc from Wilipedia)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Plain image with caption.
It contains usage information, categories and other content that is not part of the original template page.

Since MediaWiki does not provide a way to add visible captions to images integrated seamlessly in a page (i.e., without borders), this template aims to provide that functionality.

Usage

This template can be either with named parameters, as in

{{Plain image with caption|image=Example.svg|caption=Example text|width=250px|align=right|caption position=bottom}}

...or in its shorthand form:

{{Plain image with caption|Example.svg|Example text|250px|right|bottom}}
  • The only compulsory parameters are image and caption.
  • When using the shorthand version, keep in mind that the order of parameters is important
Parameter Default Acceptable values
image mandatory any image filename ("File:" or "Image:" is optional)
caption mandatory any valid wiki markup
width 250px any pixel width ("px" suffix optional)
align right left, center, right
caption position bottom top, bottom
triangle none triangle, none
triangle color #ff0080 any css color
image override Anything (lets you replace the image block with anything—useful for stacking image overlays)
caption override Anything (lets you replace the caption block with anything)

Examples

The triangle parameters give the option to add a colored triangle label—

This is a picture of the James Webb Space Telescope. Note the small triangle next to this caption.
This is a picture of the James Webb Space Telescope. Note the small triangle next to this caption.
This is a picture of the James Webb Space Telescope. Note the small triangle next to this caption.

{{plain image with caption|James Webb Space Telescope Mirror37.jpg|This is a picture of the [[James Webb Space Telescope]].|350|left|top|triangle|rgba(0,110,255,1)}}

Using "image-override" to stack images

Template:Plain image {{Plain image|File:Helical granum.png|'''Grana structure''' The prevailing model for [[granum|granal]] structure is a stack of granal [[thylakoids]] linked by helical [[stroma (fluid)|stromal]] thylakoids that wrap around the grana stacks and form large sheets that connect different grana.|432px|left|top|triangle|#3cb14d|image override=<div style="float: right; position: relative; width: 432px; height: 432px;"> <div style="float: right; position: absolute; width: 432px;">[[File:Helical granum.png|432px]]</div> <div style="float: right; position: absolute; width: 432px;">[[File:Granum labels.svg|432px|The prevailing model for [[granum|granal]] structure.]]</div></div>}}

TemplateData

Template:TemplateData header

A template for adding a caption to a frameless image

Template parameters

ParameterDescriptionTypeStatus
Imageimage

The image to use. The ''File:'' prefix is optional.

Default
Stringrequired
Image caption and alt textcaption

The caption to display under or above the image. Also sets the alt text.

Default
Stringrequired
Image widthwidth

Sets the pixel width of the image and the template. the ''px'' suffix is optional.

Default
250px
Numberoptional
Float and centeralign

Floats the template to the left, right, or centers it. Accepts ''left'', ''center'', or ''right''.

Default
right
Stringoptional
Caption positioncaption position

Determines whether the caption goes above or below the image. Accepts ''top'' or ''bottom''.

Default
bottom
Stringoptional
Triangle pointertriangle

Allows you to add a triangular pointer next to the caption text. Accepts ''triangle'' or ''none''.

Default
none
Stringoptional
Triangle pointer colortriangle color

Lets you set a CSS color for the triangular pointer.

Default
#ff0080
Stringoptional
Replacement content for the imageimage override

Lets you substitute any allowed HTML where the image would normally be.

Default
Stringoptional
Replacement content for the captioncaption override

Lets you substitute any allowed HTML where the caption would normally be.

Default
Stringoptional

See also