Figure
Inserts a graphical image.
Syntax.
<figure [nonumber] entity=entity id=id number=n>
caption string
<\figure>
|
- nonumber
Suppresses the word "Figure" and the
automatically generated figure number.
- entity=name
Specifies a file entity that identifies the file which contains the graphic image to be inserted.
- id=name
Optional. Defines an ID name that can be used in
cross-references to this figure.
- number=n
Optional. Used to override the automatically generated
figure number.
- ghyperlink="id"
Optional. Specifies that the graphic portion of
the figure be a hyperlink. References to this
location would use the specified id identifier.
- glinktype=type
Optional. Specifies the type of hyperlink. The
default type is Jump. Other type values
include JumpNewView, Definition, Man,
Execute, and AppDefined.
- gdescription="text"
Optional. Provides a description of the hyperlink. This description is used by the topic access functions.
The <\figure> end tag is required.
To integrate an external graphics file into a help topic, you must have an
entity declaration (<!entity entityname FILE "filename">)
that associates the entity name with the graphic's file name.
Examples.
The following markup inserts a graphic with the specified caption and
an automatically generated figure number:
<!entity MapFigure FILE "mappic.xwd">
.
.
.
<figure entity=MapFigure>
Caption for Figure
<\figure>
|
The following markup inserts a figure that is numbered but does not have
a caption. The figure is referred to later in the text.
<!entity MyPicture FILE "mappic.xwd">
.
.
.
<figure id=Layout entity=MapFigure>
<\figure>
.
.
.
<xref Layout> shows the layout of ...
|
The following markup inserts a figure using a specific figure number
and a caption. The caption is split into two lines where the backslash (\)
character appears.
<figure number=99 entity=SchemDiag>
Schematic that Illustrates\the Overall System Design
<\figure>
|
See Also.
Printable version
