home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / online / help.pro < prev    next >
Encoding:
Text File  |  1988-05-03  |  4.1 KB  |  103 lines
  1.  
  2. -------- SIMTEL20 Ada Software Repository Prologue ------------
  3. --                                                           -*
  4. -- Unit name    : HELP System
  5. -- Version      : 1.3
  6. -- Author       : Richard Conn
  7. --        : Echelon, Inc
  8. -- DDN Address  : RCONN at SIMTEL20
  9. -- Copyright    :
  10. -- Date created :  1 Dec 85
  11. -- Release date :  2 Mar 86
  12. -- Last update  :  2 Mar 86
  13. -- Machine/System Compiled/Run on : VAX 11/785 (VMS 4.2), DEC Ada
  14. --                                                           -*
  15. ---------------------------------------------------------------
  16. --                                                           -*
  17. -- Keywords     :  Online documentation, HELP
  18. --
  19. -- Abstract     :  
  20. -- The HELP System is a collection of programs which provide an interactive
  21. -- online documentation facility.  Data for the facility is prepared as
  22. -- a conventional text file which is formatted in an outline form, as follows:
  23. --
  24. --    0 Topic-Name
  25. --        <text of topic>
  26. --    1 1st-Level-Subtopic
  27. --        <text of subtopic>
  28. --    ...
  29. --    9 9th-Level-Subtopic
  30. --        <text>
  31. --    1 2nd-1st-Level-Subtopic
  32. --        <text>
  33. --    ...
  34. --    1 3rd-1st-Level-Subtopic
  35. --    ...
  36. --    0 Next-Topic
  37. --    ...
  38. --
  39. -- The level numbers do not have to be consecutive, and the lower the
  40. -- level number is, the higher its entry appears in the hierarchy (level 4
  41. -- elements appear before level 6).  There may be as many topics at each
  42. -- level as desired.  A line containing only a dot (.) character causes
  43. -- a break between screens when the help file is displayed to the user:
  44. --
  45. --    this line appears on one screen
  46. --    .
  47. --    this line appears on the next screen (at the top)
  48. --
  49. -- The HELP System consists of three programs: HELP, HELP_BUILD, and
  50. -- HELP_ANALYZE.
  51. --
  52. -- The HELP program is used to display information contained in a help file.
  53. -- This information is in the form of a direct-access file created by the
  54. -- HELP_BUILD program.  Briefly:
  55. --
  56. --        text of help file 
  57. --            V
  58. --            HELP_BUILD
  59. --            V
  60. --        direct-access help file
  61. --            V
  62. --        HELP displays info to user
  63. --
  64. -- The HELP_ANALYZE program displays the structure hierarchy of a direct
  65. -- access file which is created by HELP_BUILD.
  66. --
  67. --                                                           -*
  68. ------------------ Revision history ---------------------------
  69. --                                                           -*
  70. -- DATE         VERSION    AUTHOR                  HISTORY
  71. -- 31 Dec 85    1.2    Richard Conn        Production Release
  72. --  2 Mar 86    1.3     Richard Conn            Minor Revisions
  73. --                                                           -*
  74. ------------------ Distribution and Copyright -----------------
  75. --                                                           -*
  76. -- This prologue must be included in all copies of this software.
  77. --
  78. -- This software is released to the Ada community.
  79. -- This software is released to the Public Domain (note:
  80. --   software released to the Public Domain is not subject
  81. --   to copyright protection).
  82. -- Restrictions on use or distribution:  NONE
  83. --                                                           -*
  84. ------------------ Disclaimer ---------------------------------
  85. --                                                           -*
  86. -- This software and its documentation are provided "AS IS" and
  87. -- without any expressed or implied warranties whatsoever.
  88. -- No warranties as to performance, merchantability, or fitness
  89. -- for a particular purpose exist.
  90. --
  91. -- Because of the diversity of conditions and hardware under
  92. -- which this software may be used, no warranty of fitness for
  93. -- a particular purpose is offered.  The user is advised to
  94. -- test the software thoroughly before relying on it.  The user
  95. -- must assume the entire risk and liability of using this
  96. -- software.
  97. --
  98. -- In no event shall any person or organization of people be
  99. -- held responsible for any direct, indirect, consequential
  100. -- or inconsequential damages or lost profits.
  101. --                                                           -*
  102. -------------------END-PROLOGUE--------------------------------
  103.