1 02/20/80  fig.compin
 2 
 3 Syntax:  .ifi fig "figure-title"
 4 
 5 
 6 Function:
 7 This compose macro
 8 1) increments the figure counter
 9 2) outputs a centered, perhaps multiline figure caption below the
10    figure with appropriate spacing between figure and caption
11 3) adds the 'figure-title' to the list of Illustrations in the Table of
12    Contents if the creation of such a list has been enabled (see
13    fig_on.info)
14 
15 
16 Arguments:
17 'figure-title' is the title of the figure, as it is to appear in the
18    list of Illustrations in the Table of Contents (initial caps, no
19    underlines).
20 
21 
22 Notes:
23 1) The figure counter is maintained on a per-section basis for
24    documents done in sections (those in which the 'section' variable
25    has been set), and on a per-document basis for all other documents.
26 2) After the fig macro is used, the 'figure' compose variable contains
27    the figure number of the current figure.  'figure' will be of the
28    form '<section>-N' if the 'section' variable has been set.  'figure'
29    can be used in the text to refer to the current figure.  (See
30    fig_get_no.info for references to a figure other than the current
31    figure.)
32 3) See fig_index.info, fig_on.info, and fig_get_no.info for related
33    information.
34 
35 
36 Examples:
37 If the first use of the fig macro in an unsectioned document is
38      .ifi fig "Figure Title"
39 the result is
40 
41                         Figure 1.  Figure Title
42 
43 If the fourth use of the fig macro in Section 3 of a document is
44      .ifi fig "First Part of  Figure Title!Second Part of Figure Title"
45 the result is
46 
47                 Figure 3-4.  First Part of Figure Title
48                       Second Part of Figure Title
49 
50 
51 The following lines generate a simple figure preceding some text.
52                      _________               __________
53                     |         |             |          |
54                     |_________|             |__________|
55      .ifi fig "Two Boxes"
56      .ur The two boxes in Figure %figure% above ...
57 
58 The result is
59 
60                      _________               __________
61                     |         |             |          |
62                     |_________|             |__________|
63 
64                           Figure 1.  Two Boxes
65 
66      The two boxes in Figure 1 above...
67 
68 (END)