1 12/14/80  dot_fig.compin
 2 
 3 Syntax:  .ifi dot_fig "figure-title"
 4 
 5 
 6 Function:
 7 This compose macro
 8 1) increments the figure "dot number" 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.compin.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 "dot number" counter is maintained on a per-section basis
24    for documents done in sections (those in which the 'section'
25    variable has been set), and on a per-document basis for all other
26    documents.
27 2) After the dot_fig macro is used, the 'figure' compose variable
28    contains the figure number of the current figure.  'figure' will be
29    of the form '<section>-<last_fig_no>.N' if the 'section' variable
30    has been set.  'figure' can be used in the text to refer to the
31    current figure.  (See dot_fig_get_no.compin.info and
32    fig_get_no.compin.info for references to a figure other than the
33    current figure.)
34 3) The dot_fig macro cannot be used without an existing <last_fig_no>,
35    that is, it must follow some use of the fig or fig_index macros.
36    The next use of the fig, fig_index, or fig_get_no macro resets the
37    figure "dot number" counter back to zero.
38 4) See dot_fig_index.compin.info, fig_index.compin.info,
39    dot_fig_get_no.compin.info, fig_get_no.compin.info, and
40    fig_on.compin.info for related information.
41 
42 
43 Examples:
44 To add a Figure after Figure 3-3 of a document...
45      .ifi dot_fig "Added Figure"
46 resulting in...
47 
48                       Figure 3-3.1.  Added Figure
49 
50 (END)