1 11/30/86  l1h.compin, l2h.compin, l3h.compin, l4h.compin
  2 
  3 Syntax:  .ifi lXh "paragraph-title"
  4 
  5 
  6 Function:  These macros generate paragraph headings with
  7 'paragraph-title' translated into the font defined for the level
  8 (except see "Module and prose modes" below) and generate an appropriate
  9 entry in the Table of Contents.
 10 
 11 
 12 Arguments:
 13 'paragraph-title' is the paragraph title as it is to appear in the
 14    Table of Contents (except see "Module and prose modes" below)
 15 
 16 
 17  Module and prose modes:
 18  If 'paragraph-title' begins with the UNDERLINED words 'Name', 'Names',
 19  'Entry', or 'Entries' followed by a colon (:), the macros switch from
 20  prose description to module description and remain in the new mode for
 21  the rest of the section or document (or until the next use of l0h or
 22  one of the 'init' macros).  The 'paragraph-title' causing the switch
 23  is NOT translated into the level font, but is set into the paragraph
 24  heading as is.  The initial word and the colon are stripped off the
 25  Table of Contents entry.
 26 
 27 
 28 The 'Name' and 'Names' forms cause a new page to be begun and a boxed
 29 page header to be generated for the first (or only) name given.
 30 
 31 
 32 The 'Entry' and 'Entries' forms cause a half-page-width horizontal
 33 separtor bar to be placed on the page.
 34 
 35 
 36 When in module description mode, the macros DO NOT generate Table of
 37 Contents entries for 'paragraph-title's that do not begin with the
 38 keywords above.
 39 
 40 
 41 The macro supports multiline headers by honoring the "!"  convention.
 42 The entry:
 43 
 44         .ifi l4h "Paragraph Title! (subtitle)"
 45 
 46  will generate the header:
 47 
 48         Paragraph title
 49           (subtitle)
 50 
 51 The macro will honor the current linelength so that headers are
 52 adjusted to fit the shorter lines when using multicolumn format.
 53 
 54 
 55 Examples:
 56 A section in the MPM Commands might contain
 57 
 58         .ifi init_mpm "AG92"
 59         .sr section 1
 60         .ifi l0h "Multics Command Environment"
 61              The Multics command environment ....
 62         .ifi l1h "Reference to Commands by Function"
 63              The Multics command repertoire ...
 64         .ifi l2h "Access to the System"
 65 
 66 
 67 A module description with a standard size page might contain
 68 
 69         .ifi init_plm "AN80"
 70         .ifi l1h "Names:  check_mst, ckm"
 71              This command is used to read one ...
 72         .ifi l2h "Usage"
 73              check_mst input_args control_args
 74         .sp 1
 75         where:
 76         .sp 1
 77         .inl 12
 78         .unl 12
 79         1.   input_args     ...
 80         .brf
 81         .unl 12
 82 
 83 
 84 
 85         2.   control_args   ...
 86              .
 87              .
 88              .
 89         .inl 0
 90         .ifi l2h "Notes"
 91              The control arguments ...
 92         .ifi l2h "Entry:  check_mst$test"
 93              This entry point may be used to test the ...
 94 
 95 
 96 
 97 
 98  Change bars:
 99  If the .ifi line in the calling file is within the range of an active
100  change-bar control and a Table of Contents entry is to be made, the
101  active change-bar mark will also be shown on the Table of Contents
102  entry.  However, if a new section is being ADDED (without change-bars)
103  with the dot-page feature you must use the following to get the Table
104  of Contents change-bars:
105 
106        .ifi dot_page X
107        .ifi l?exact "New Section Title"
108        .cba
109        .ifi l?toc "New Section Title"
110        .cbf
111 
112 
113 Notes:
114 To cancel a box header set with LXhbox, the user should enter:
115 
116         .ifi lXhbox ""
117 
118 The new box header implemented makes the prose_box and
119 prose_box_off macros obsolete, but the entrypoints will be
120 retained because of their extensive use in the COBOL
121 documentation.