// vim: set filetype=pp2html:
\INCLUDE{type=pp file="basic-tag-macros.pp" smart=1}
=IMAGE
\X{mode=index_only}
The \B<\\IMAGE> tag includes an image.
\B
\\IMAGE{options}
\B
This tag supports various options. Unless explicitly noted, all options are optional.
\I
These options are supported by all translators.
:\B:This is the most important and therefore \B option, setting up
the pathname of the image file.
The path can be \I or \I. Relative pathes are relative to the
document \I. (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="\Bimage.gif"}
// relative image pathes
\\IMAGE{src="image.gif"}
\\IMAGE{src="../image.gif"}
\\IMAGE{src="images/image.gif"}
\I
Several translators may extend the set of supported options.
\B allows also the following options which are passed to the corresponding
parameters of the HTML ![]()
tag:
:\B: Specify a textual alternative for the image.
:\B: Specify the height of the image
:\B: Specify the width of the image
:\B: Specify border width. A useful value is "0" to suppress the border.
:\B: Specify justification.
\B
No body is allowed. A used body will not be recognized as a body of this tag.
\B
\B<\\IMAGE> is part of the \I supported by \I PerlPoint translators.
\B
This simple example
Look at this \\IMAGE{src="image.gif"}.
produces something like
Look at this \IMAGE{src="image.gif"}.
\B
More basic set tags: \OTHER_BASIC_TAGS{current=IMAGE}.