home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / games / volume14 / okbridge2 / part02 / help.h next >
C/C++ Source or Header  |  1993-01-27  |  3KB  |  74 lines
  1. /* help.h -- help functions for the bridge program.
  2.  *
  3.  ! Copyright (C) 1990-1992 by Matthew Clegg.  All Rights Reserved
  4.  ! 
  5.  ! OKbridge is made available as a free service to the Internet.
  6.  ! Accordingly, the following restrictions are placed on its use:
  7.  ! 
  8.  ! 1.  OKbridge may not be modified in any way without the explicit 
  9.  !     permission of Matthew Clegg.  
  10.  ! 
  11.  ! 2.  OKbridge may not be used in any way for commercial advantage.
  12.  !     It may not be placed on for-profit networks or on for-profit
  13.  !     computer systems.  It may not be bundled as part of a package
  14.  !     or service provided by a for-profit organization.
  15.  ! 
  16.  ! If you have questions about restrictions on the use of OKbridge,
  17.  ! write to mclegg@cs.ucsd.edu.
  18.  ! 
  19.  ! DISCLAIMER:  The user of OKbridge accepts full responsibility for any
  20.  ! damage which may be caused by OKbridge.
  21.  *
  22.  * This file contains the interface for a help procedure for the
  23.  * bridge program.  The help function is organized as a series of topics,
  24.  * headed by a main topic.  All of the help information is stored in a
  25.  * single file, organized as a list of topics.  The first entry in the
  26.  * file is interpreted to be the main topic, i.e., it is the entry which
  27.  * is displayed if no particular keyword is given.  Each topic entry
  28.  * has a header line which contains an identifying keyword and a 
  29.  * descriptive phrase.  This is followed by the body of the entry
  30.  * and is terminated by an end-of-entry line.  The format of the header
  31.  * line is simply
  32.  *  <keyword> <phrase>
  33.  * where <keyword> is any text string not containing white space characters.
  34.  * The body of the entry consists simply of a series of text lines.
  35.  * These are displayed in order on the screen.  However, a line beginning
  36.  * with the circumflex '^' character is displayed at the beginning of a
  37.  * new page.  A help entry is terminated by a line containing just the
  38.  * two characters '--'.  The last entry in the file need not have this
  39.  * terminator.  The help file may also contain comment lines.  These
  40.  * begin with the pound sign '#' character.
  41.  */
  42.  
  43. extern initialize_help_system ();
  44. /* Called once at the beginning of the program to read the file of help
  45.  * topics.
  46.  */
  47.  
  48. extern int display_help ();
  49. /* void display_help (char *topic); */
  50. /* Displays help on the given topic.  This consists of looking up the
  51.  * help file associated to this topic and displaying the contents of this
  52.  * file on the screen.  If the topic string is empty, then displays first
  53.  * the contents of the main topic file.  Returns 0 if the requested topic
  54.  * was found, and 1 otherwise.
  55.  */
  56.  
  57. extern void browse_help ();
  58. /* void browse_help (char *name); */
  59. /* Displays help on the given topic.  Afterwards, displays a list of
  60.  * topics along with a request to enter the name of a new topic.
  61.  */
  62.  
  63. extern void display_topics ();
  64. /* void display_topics (char *header_message); */
  65. /* Displays the list of help topics. */
  66.  
  67. extern void Refresh_Help_Display ();
  68. /* void Refresh_Help_Display (void); */
  69. /* Redisplays the current screen of help information. */
  70.  
  71. extern void Clear_Help_Display ();
  72. /* void Clear_Help_Display (void); */
  73. /* Returns the help system to its initial state. */
  74.