Tags:
create new tag
, view all tags

Exhaustive Test Page for ImagePlugin

The syntax for displaying an image is

%IMAGE{"foo.gif" web="Plugins" topic="ImagePluginTest" type="thumb|thumbnail|frame" align="left|center|right|none" size="nn" caption="caption text"}%

Only %IMAGE{"name"}% is required. The other details are optional and can be placed in any order.

type
'thumb' / 'thumbnail' or 'frame'. Causes image to be displayed with specific formatting (see below).
align
'right', 'left', 'center' or 'none'. Determines placement of the image on the page.
size
{width}px or {width}x{height}px (e.g. 50x40px, would limit width to 50 and height to 40).
caption
Text to be used as caption text under the image
web
the Web where the image is attached.
topic
The topic (within the web) where the image is attached.

  • Initial image name is required.
  • The other arguments are optional and are order independent
    Option Values Default
    web "<web>" (current web)
    topic "<topic>" (current topic)
    type "thumb|thumbnail|frame" empty
    align "left|center|right|none" "right"
    size "<nn>" (image width)
    caption "<caption text>" empty

Syntax to use an image in uploaded size, with a caption

To use an image as uploaded with a caption use %IMAGE{"Westminstpalace.jpg" type="frame" align="none" caption="caption text"}%. This is the syntax you should use to update images that used the original image markup of the form %IMAGE{"Westminsterpalace.jpg|caption"}%.

%IMAGE{"Westminstpalace.jpg" type="frame" align="none" caption="caption text"}%

Syntax for images with no automatic caption or formatting

The old syntax for images without captions is %IMAGE{"Westminstpalace.jpg|alt text"}%. This is rendered inline, and the specified text is used as the image's ''alt'' attribute (alternate text for programs which cannot display images, such as screen readers) and as the ''title'' attribute (supplementary text, often displayed as a tool tip when the mouse is over the image).

Example

%IMAGE{"Westminstpalace.jpg|alt text"}%

New syntax for images

%IMAGE{"Westminstpalace.jpg" type="thumb" size="100" align="left" caption="The Palace of Westminster"}% In the syntax %IMAGE{"Westminstpalace.jpg" type="thumb" size="100" align="left" caption="The Palace of Westminster"}% shown in the left), several options can be set when including an image. Those affect the placing of the image, its size or the way the image will be presented. The options are right, left, center, none, _size_px, thumbnail (thumb), frame, and _alternate (caption) text_. %IMAGE{"CLR"}%

%IMAGE{"Westminstpalace.jpg" type="thumb" size="200" align="right" caption="From the Thames"}% The options can be combined, and spaces ("") are used to separate options from each other. The options can be put in any order. %IMAGE{"Westminstpalace.jpg" type="thumb" size="200" align="right" caption="From the Thames"}% (shown on the right). %IMAGE{"CLR"}%

Here is the description of the options other than the caption text (shown on the right). %IMAGE{"CLR"}%

right
%IMAGE{"Westminstpalace.jpg" align="right" size="70"}%The image is right-aligned, and text floats to the left of the image %IMAGE{"Westminstpalace.jpg" align="right" size="70"}% (shown on the right). %IMAGE{"CLR"}%
left
%IMAGE{"Westminstpalace.jpg" align="left" size="70"}%The image is left aligned, and text floats to the right of the image %IMAGE{"Westminstpalace.jpg" align="left" size="70"}% (shown on the left). %IMAGE{"CLR"}%
center
The image is centered, and...%IMAGE{"Westminstpalace.jpg" align="center" size="70"}%the text following the image starts below it %IMAGE{"Westminstpalace.jpg" align="center" size="70"}% (shown above). %IMAGE{"CLR"}%
none
The image is put at the left, and...%IMAGE{"Westminstpalace.jpg" align="none" size="70"}%the text following does not float to the right (or to the left, obviously), and starts below it %IMAGE{"Westminstpalace.jpg" align="none" size="70"}% (shown above). %IMAGE{"CLR"}%

size px
%IMAGE{"Westminstpalace.jpg" align="right" size="50"}% This option renders a version of the image that's [size] pixels wide (e.g. %IMAGE{"Westminstpalace.jpg|right|50px|"}% shown on the right). Height is computed to keep aspect ratio (image)|aspect ratio (i.e. the shape of the image).%IMAGE{"CLR"}%

Notes
Specifying a size does not just change the apparent image size using HTML; it actually generates a resized version of the image on the fly and links to it appropriately. This happens whether or not you use size in conjunction with thumb.
If you specify a "frame" option the image will not be scaled, and no size specifiers will be in the HTML. The image will be rendered at full size%IMAGE{"CLR"}%

thumbnail, thumb
%IMAGE{"Westminstpalace.jpg" type="thumbnail" align="left" size="100"}% %IMAGE{"Westminstpalace.jpg" type="thumb" caption="The Palace of Westminster"}% The thumbnail (thumb) option generates a thumbnail|thumbnail image. It is automatically resized when the "size" attribute is not specified. Without the options left, center, and none, the image is normally on the right. If the image has a caption text, it is displayed in the lower margin. E.g. %IMAGE{"Westminstpalace.jpg" type="thumbnail" align="left" size="100"}% (shown on the left) and %IMAGE{"Westminstpalace.jpg" type="thumb" caption="The Palace of Westminster"}% (shown on the right).%IMAGE{"CLR"}%

%IMAGE{"Tst.png" align="right" type="thumb" size="100" caption="This is a globe, and take a look at it in nested"}% An "enlarge"-icon is put also in the lower margin of the thumbnail. Both the image itself and the icon link to the image description page with the image in its actual size. The icon shows the link title "Enlarge" in its hoverbox, even in cases where this term does not apply, because it leads from the enlarged image to the one with the actual size. E.g. %IMAGE{"Tst.png" align="right" type="thumb" size="100" caption="This is a globe, and take a look at it in nested"}% (shown on the right). %IMAGE{"CLR"}%

frame
%IMAGE{"Westminstpalace.jpg" type="frame" size="50" caption="The Palace of Westminster"}% With this option, the embedded image is shown with its actual size enclosed by a frame, regardless of the "thumb" or "size" attribute, and the caption, if any, is visible in the frame. Without the options left, center, and none, the image is normally on the right %IMAGE{"Westminstpalace.jpg" type="frame" size="50" caption="The Palace of Westminster"}%.
%IMAGE{"CLR"}%

With none of the options other than size px and alternate (caption) text, an embedded image is rendered inline.

text text text text text text
=%IMAGE{"Westminstpalace.jpg" size="150" caption="The Palace of Westminster"}%=
text text text text text
=%IMAGE{"Tst.png" size="100" caption="This is a globe."}%=
text text text text

gives

text text text text text text %IMAGE{"Westminstpalace.jpg" size="150" caption="The Palace of Westminster"}% text text text text text %IMAGE{"Tst.png" size="100" caption="This is a globe."}% text text text text %IMAGE{"CLR"}%

Cancelling floating-around-image mode

After having had an image floating next to text, putting further text below it and again using the full width can be done with the following markup. This blocks an image from appearing next to the material following this markup, possibly due to aesthetic reasons or a change in topics.

<br style="clear:both" />

For legacy align="right" (etc.) floating this isn't good enough, legacy browsers would ignore inline CSS. To cancel floating under all conditions the following markup (valid XHTML 1.0 transitional) works

<br clear="all" />

The same code can be issued by using template %IMAGE{"CLR"}%

Linking to the image description page

If you want to make a link to the description page for an image, use a leading colon before "image" in an intra-wiki link, like this %IMAGE{"STS-32_crew.jpg|STS-32 crew"}% which yields %IMAGE{":STS-32_crew.jpg|STS-32 crew"}%

-- CraigMeyer - 09 May 2006

Moved & Renamed from Sandbox.

-- CraigMeyer - 18 Aug 2006

Topic attachments
I Attachment History Action Size Date Who Comment
JPEGjpg Buckingham_palace_Copyright2003KaihsuTai.jpg r1 manage 14.9 K 2006-05-09 - 15:22 CraigMeyer Example Image 1/4
JPEGjpg Westminstpalace.jpg r1 manage 19.3 K 2006-05-09 - 15:23 CraigMeyer Example Image 2/4
Edit | Attach | Watch | Print version | History: r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r4 - 2006-09-25 - MichaelDaum
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.