4. CA MICS Facilities › 4.6 Documentation Programs › 4.6.1 Document Utility Control Commands › 4.6.1.3 Heading and Table of Contents Commands

4.6.1.3 Heading and Table of Contents Commands

The heading and table of contents commands trigger section
heading titles or table of contents entries.


$BOOK 28-character-bookname

   Signals MICSDOC to print the abbreviated name of the
   document, as provided in the 28-character book name.  This
   name will appear on the bottom of two up pages to the left
   of the chapter-page number.  For example:

              $BOOK CA MICS Intro Guide

   causes "CA MICS Intro Guide" to be printed at the bottom
   of each guide page.  By convention, the preferred place
   for these commands is in the ii$TTL member for each guide.

$CPYR yyyy

   Supplies the document copyright date in the form of yyyy.
   This is the date used in the copyright notice printed at
   the lower left corner of the documentation box when
   printing two up documents such as CA MICS guides.

$DMEM mmmmmmmm ttt...

   This dollar command assembles text members and also
   creates section heading information.  It identifies a data
   dictionary entry and is used to generate the detailed
   table of contents entry.  "mmmmmmmm" is the member name of
   the element, and "ttt..." is the descriptive name of the
   element.  "ttt" may contain up to 40 characters.

$FIG Figure n-nn.  Title

   This command prints a title underneath a figure and also
   provides an entry for the figure table of contents.  The
   number to the left of the hyphen is the chapter number;
   the number to the right of the hyphen is a sequence
   number.  The sequence number may have periods within it
   and must have a period at the end.

$FIGC Figure n-nn.  Title

   The same as $FIG, except that the Figure n-nn.  Title line
   is centered based on the current line size.  This command
   makes is easier to put a title on a figure, especially
   when the body of the figure is copied using $LMEM.

$HEDR n.n.n - section title
$HEDR Chapter nn.  CHAPTER TITLE

   Signals the start of a new section or chapter, and
   provides the tables of contents entry.  "nn" is the
   chapter or section number.  The number of periods in this
   number defines the level of indentation in the table of
   contents.  The chapter number must end with a period; the
   section number must not.  The section number and title
   should be separated by a hyphen; the chapter number and
   title should not be.  The number, title, and "Chapter" (if
   present) can contain a total of 61 characters.

$HEDE nnn...  ttt...

   Identifies a CA MICS exception type for inclusion in the
   detailed table of contents.  "nnn..." is the number of the
   exception type, and "ttt..." is a one-line description of
   the exception (the long name of the exception).

$PDAT 18-character-date

   Signals MICSDOC to override the value in the print date
   field using the text provided in the 18-character-date
   field.  This string will appear on the bottom of 2UP pages
   to the right of the chapter-section number.  Example:

              $PDAT Oct 1989 Level

   causes "Oct 1989 Level" to be printed at the bottom of
   each Guide page instead of using the actual print date.
   By convention, the preferred place for these commands is
   in the @ii$TTL member for each guide.

$$TOC

   Marks the point in the text at which the tables of
   contents are inserted.  If more than one $$TOC is
   encountered, the tables of contents are inserted only
   where the first $$TOC occurs.