1 11/27/80 example.compin, example_off.compin
 2 
 3 Syntax: .ifi example {N} {tablename}
 4      and at the end of the example
 5         .ifi example_off
 6 
 7 
 8 Function:
 9 This pair of macros formats a terminal session input/output (or
10 lineprinter output) example.
11 
12 
13 Macro Actions:
14 1) separates the example from main body text by 12 pt of white space
15 2) generates a ruled box from the current indentation level to the
16    right margin to enclose the example
17 3) increases the indentation level (inside the box) by N+1 (See Notes
18    below) for the body of the example.  The default value for N is 0;
19    however, if {tablename} is given, N must also be given.
20 4) sets the body of the example in 9pt ascii font
21 5) if {tablename} is given; establishes the table format {tablename}
22    assuming column 2 of the format in meant for comments, allows for a
23    hanging hyphen on the first line of such comments, and sets the
24    comments in 10pt Century Schoolbook Roman
25 6) the example_off entry reverts all the above actions and returns to
26    main body text format
27 
28 
29 Notes:
30 1) For those devices that do not support ruled lines, use of the -noart
31    control argument (see description of compose in AZ98) will suppress
32    the ruled box.
33 2) Examples that exceed one full page are split across pages with the
34    box remaining open at the page breaks.
35 3) The body of the example is normally set 1 indentation level in from
36    the main body text.  However, if the example is to display bullets
37    (for user input lines) or reference line numbers for use in main
38    body text discussion, N must be given as 1 to get the extra space.
39    If BOTH bullets and line numbers are wanted, N must be given as 2.
40    (See bullet.compin.info, ex_lineno.compin.info, and
41    reset_ex_lineno.compin.info for further information on bullets and
42    reference line numbers.)
43 
44 (END)