Template:Plain image with caption/doc

From Ekatra Wiki
Jump to navigation Jump to search

Lua error in package.lua at line 80: module 'strict' not found.

Lua error in package.lua at line 80: module 'strict' not found.

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|upright=1|align=right|caption position=bottom}}

...or in its shorthand form:

{{Plain image with caption|Example.svg|Example text|upright|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
upright 1 any decimal number (decimal point is optional)
width none any pixel width ("px" suffix optional)
height none any pixel height ("px" suffix optional)
align right left, center, right, none
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.
This is a picture of the James Webb Space Telescope.

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

Using "image-override" to stack images

Grana structure The prevailing model for granal structure is a stack of granal thylakoids linked by helical stromal thylakoids that wrap around the grana stacks and form large sheets that connect different grana.
Helical granum.png
The prevailing model for granal structure.

{{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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Plain image with caption in articles based on its TemplateData.

TemplateData for Plain image with caption

A template for adding a caption to a frameless image.

Template parameters

ParameterDescriptionTypeStatus
Imageimage 1

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

Default
Stringrequired
Image caption and alt textcaption 2

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

Default
Stringrequired
Image width scaling factorupright

Decimal multiplier that sets the width of the image relative to the user's preferred thumbnail size, as set in their Preferences (220px by default or when not logged in). Decimal point optional.

Default
1
Example
0.75
Stringoptional
Image widthwidth 3

Sets the pixel width of the image. Per WP:THUMBSIZE, fixed image widths should not be used unless align is set to ''center'' or otherwise necessary. The ''px'' suffix is optional.

Default
Numberoptional
Image heightheight

Sets the pixel height of the image. The ''px'' suffix is optional.

Numberoptional
Float and centeralign 4

Floats the template to the left, right, or centers it. Accepts ''left'', ''center'', ''right'', or ''none''. If set to ''center'', width must be set to a pixel-defined width, or else an error will be displayed.

Default
right
Stringoptional
Caption positioncaption position 5

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

Default
bottom
Stringoptional
Triangle pointertriangle 6

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

Default
none
Stringoptional
Triangle pointer colortriangle color 7

Lets you set a CSS color for the triangular pointer.

Default
#ff0080
Stringoptional
Replacement content for the imageimage override 8

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

Default
Stringoptional
Replacement content for the captioncaption override 9

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

Default
Stringoptional

See also