Template:Plain image with caption/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

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[edit source]

This template can be either with named parameters, as in

{{plain image with caption|image=Example.svg|caption=Example text|width=250|align=right}}

...or in its shorthand form:

{{plain image with caption|Example.svg|Example text|250|right}}
  • The only compulsory parameters are image and caption. The width defaults to 250px, and the alignment defaults to right
  • When using the shorthand version, keep in mind that the order of parameters is important
  • Please notice that the width does not include the unit "px" (see the code below)

Technical[edit source]

The template wraps the image in an HTML table wrapper bounding the wrapper margins relative to the image width. The table positions the construct right or left and isolates it from other page text intrusion with fixed padding.

Actual internal coding[edit source]

The equivalance between placeholder and named parameters is shown here below:

{| style="float:{{{4|{{{align|right}}}}}}; width:{{{3|{{{width|250}}}}}}px;
 margin:1em; background:transparent;"
| [[Image:{{{1|{{{image<noinclude>|Example.svg</noinclude>}}}}}}
| right|{{{3|{{{width|250}}}}}}px|{{{2|{{{caption<noinclude>|Caption goes here.</noinclude>}}}}}}]]
|<span style="font-size:85%;">{{{2|{{{caption<noinclude>|Caption goes here.</noinclude>}}}}}}</span>

So the placeholder parameters map as named parameters to operational HTML in order:

  1. image:   {{{image}}} or {{{1|}}}
  2. caption: {{{caption}}} or {{{2|}}}
  3. width:  {{{width}}} or {{{3|}}}defaults to 250 and adds the 'px;' suffix, so leave it off!
  4. float:   {{{align}}} or {{{4|}}}