Next: L   Previous: I   Contents: Contents

IMAGE

The \IMAGE tag includes an image.

Syntax

\IMAGE{options}

Options

This tag supports various options. Unless explicitly noted, all options are optional.

Basic options

These options are supported by all translators.

src
This is the most important and therefore mandatory option, setting up the pathname of the image file. The path can be relative or absolute. Relative pathes are relative to the document containing the tag. (This means if documents are nested and the nested source contains this tag, relative pathes will still be relative to the path of this nested source. This way it is possible to bundle partial documents with their images.) The image file is checked for existence when the tag is parsed. A missed file causes a semantic error.

  // an absolute image path
  \IMAGE{src="/images/image.gif"}

  // relative image pathes
  \IMAGE{src="image.gif"}
  \IMAGE{src="../image.gif"}
  \IMAGE{src="images/image.gif"}

Additional options

Several translators may extend the set of supported options. pp2html allows also the following options which are passed to the corresponding parameters of the HTML <IMG> tag:

alt
Specify a textual alternative for the image.
height
Specify the height of the image
width
Specify the width of the image
border
Specify border width. A useful value is "0" to suppress the border.
align
Specify justification.

Body

No body is allowed. A used body will not be recognized as a body of this tag.

Notes

\IMAGE is part of the basic tag set supported by all PerlPoint translators.

Example

This simple example


  Look at this \IMAGE{src="image.gif"}.

produces something like


  Look at this ../../images/image.gif.

See also

More basic set tags: B, C, EMBED, FORMAT, HIDE, I, INCLUDE, LOCALTOC, READY, REF, SEQ, STOP and TABLE.

Next: L   Previous: I   Contents: Contents