home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / games / volume13 / okbridge / part07 / help.h < prev    next >
C/C++ Source or Header  |  1992-01-13  |  2KB  |  55 lines
  1. /* help.h -- help functions for the bridge program.
  2.  ! 
  3.  ! Copyright (C) 1990,1991 by Matthew Clegg
  4.  ! 
  5.  ! This program may be copied and distributed freely.  Please do not
  6.  ! charge money for this program or for any program derived from it.
  7.  ! If you modify this program, then include a notice stating plainly
  8.  ! that your program is derived from the okbridge program and is not
  9.  ! the same as the official okbridge program.
  10.  !
  11.  ! I welcome any suggestions for improvement to okbridge, and 
  12.  ! I would be especially happy to receive improved source code.
  13.  ! If you have comments or suggestions, or if you would like to
  14.  ! join the okbridge mailing list, then write to
  15.  !
  16.  !   mclegg@cs.ucsd.edu
  17.  !
  18.  *
  19.  * This file contains the interface for a help procedure for the
  20.  * bridge program.  The help function is organized as a series of topics,
  21.  * headed by a main topic.  All of the help information is stored in a
  22.  * single file, organized as a list of topics.  The first entry in the
  23.  * file is interpreted to be the main topic, i.e., it is the entry which
  24.  * is displayed if no particular keyword is given.  Each topic entry
  25.  * has a header line which contains an identifying keyword and a 
  26.  * descriptive phrase.  This is followed by the body of the entry
  27.  * and is terminated by an end-of-entry line.  The format of the header
  28.  * line is simply
  29.  *  <keyword> <phrase>
  30.  * where <keyword> is any text string not containing white space characters.
  31.  * The body of the entry consists simply of a series of text lines.
  32.  * These are displayed in order on the screen.  However, a line beginning
  33.  * with the circumflex '^' character is displayed at the beginning of a
  34.  * new page.  A help entry is terminated by a line containing just the
  35.  * two characters '--'.  The last entry in the file need not have this
  36.  * terminator.  The help file may also contain comment lines.  These
  37.  * begin with the pound sign '#' character.
  38.  */
  39.  
  40. extern initialize_help_system ();
  41. /* Called once at the beginning of the program to read the file of help
  42.  * topics.
  43.  */
  44.  
  45. extern display_help ();
  46. /* void display_help (char *topic); */
  47. /* Displays help on the given topic.  This consists of looking up the
  48.  * help file associated to this topic and displaying the contents of this
  49.  * file on the screen.  If the topic string is empty, then displays first
  50.  * the contents of the main topic file, and then displays a list of the
  51.  * topics.  If there is no help on the given topic, then displays a list
  52.  * of topics.
  53.  */
  54.  
  55.