FIG (Figure)

The FIG tag defines the format of text so that it is set off from other text on the panel and retains the format of the enclosed text.

Syntax


>>-<FIG--+-----------------+--+-----------------+--+--------+--->
         |        .-RULE-. |  |        .-PAGE-. |  '-NOSKIP-'   
         '-FRAME=-+-NONE-+-'  '-WIDTH=-+-COL--+-'               

>-->--+----------------+--</FIG>-------------------------------><
      '-figure-content-'

Parameters

FRAME=RULE | NONE

This attribute specifies the type of frame to put around the figure.

RULE: Specifies dashed lines appears above and below the figure.
NONE: Specifies no frame; a blank line is left above and below the figure.

WIDTH=PAGE | COL

This attribute specifies where the figure should be aligned. The value PAGE (the default) formats the figure on the original left margin. The value COL formats the figure on the current left margin. The current left margin may be different than the original left margin of the panel if the FIG tag is nested within another tag that causes indenting; the UL tag, for example.

NOSKIP

This attribute causes the blank line normally placed before the figure to be skipped.

figure-content

This is the text of the figure definition.

Comments

The FIG tag defines the format of text so that it is set off from other text on the panel and retains the format of the enclosed text. Tags that normally cause word wrapping within an information region (such as P, NOTE, or PARML) do not cause word-wrapping when nested within a FIG definition. In addition, blank spaces and blank lines in the source are preserved in the figure.

If any DTL source text line is too long to fit in the remaining available formatting width, the data is truncated. A warning message is issued when the first line within the figure is truncated.

A figure can also contain a figure caption, defined with the FIGCAP tag (see FIGCAP (Figure Caption)).

Restrictions

The FIG tag requires an end tag.
You must code the FIG tag within an INFO definition. See INFO (Information Region) for a complete description of this tag.

Processing

Table 1. The tags you can code within a FIG definition
Tag	Reference	Usage	Required
DL	DL (Definition List)	Multiple	No
FIGCAP	FIGCAP (Figure Caption)	Single	No
HP	HP (Highlighted Phrase)	Multiple	No
NOTE	NOTE (Note)	Multiple	No
NOTEL	NOTEL (Note List)	Multiple	No
NT	NT (Note)	Multiple	No
OL	OL (Ordered List)	Multiple	No
P	P (Paragraph)	Multiple	No
PARML	PARML (Parameter List)	Multiple	No
PS	PS (Point-and-Shoot)	Multiple	No
RP	RP (Reference Phrase)	Multiple	No
SL	SL (Simple List)	Multiple	No
UL	UL (Unordered List)	Multiple	No
XMP	XMP (Example)	Multiple	No

Examples

Here is help panel markup that contains a figure definition with a ruled frame. The output of the text within the figure definition is identical to the figure-content. Figure 1 shows the formatted result.

<!DOCTYPE DM SYSTEM>

<HELP NAME=fig DEPTH=20>ShelfBrowse Help
<AREA>
<INFO>
  <FIG>

    We're your local library...

           CHECK US OUT!


  </FIG>
</INFO>
</AREA>
</HELP>

Figure 1. Figure

                 ShelfBrowse Help

 ------------------------------------------------

     We're your local library...

            CHECK US OUT!


 ------------------------------------------------







  F1=Help         F3=Exit         F5=Exhelp
  F6=Keyshelp     F7=PrvTopic     F8=NxtTopic
 F10=PrvPage     F11=NxtPage     F12=Cancel