home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / online / help.ex2 < prev    next >
Encoding:
Text File  |  1988-05-03  |  8.0 KB  |  244 lines
  1.     HELP.EX2 -- Demo 2 of HELP System for Ada Repository
  2.  
  3.             Richard Conn
  4.  
  5.     The following text shows the execution of the HELP program
  6. on the HELP.DAT data file after it has been processed by the HELP_BUILD
  7. program.  See the directory PD:<ADA.ONLINE-DOC> for documentation and
  8. source code on these programs.  During the terminal displays, explanatory
  9. comments are presented as lines preceeded with the "--" characters.  This
  10. example was run under a DEC VAX 11/785 running VMS 4.2; the DEC Ada compiler
  11. was used to compile the HELP System programs.  This file is in
  12. PD:<ADA.ONLINE-DOC> as HELP.EX2 on SIMTEL20.
  13.  
  14.     Users of the Ada Repository can periodically copy new HELP.DAT
  15. files from PD:<ADA.ONLINE-DOC> as these files are released.  HELP.DAT
  16. contains a current snapshot of the entire repository, and the HELP program
  17. allows the user to interactively query this data in a tree-oriented
  18. fashion.  Details on all major directories, including current listings
  19. of all files in each directory, and details of each software item (program
  20. or software component) are available.  The following session should
  21. illustrate.  Please address questions to ADA-SW-REQUEST@SIMTEL20.
  22.  
  23.         ---- Terminal Session Follows ----
  24.  
  25. -- The HELP program is run and the default data file is selected.
  26. -- The top-level set of topics is presented with a prompt.
  27. HELP, Version 1.2
  28. Help File (RETURN for Default)> 
  29. Ada                   AI                    ANSI-LRM              
  30. Benchmarks            CM_Data               Compilation_Order     
  31. Components            Cross_Reference       DDN                   
  32. Editors               Education             External_Tools        
  33. Forms_Generator       General               Graphical_Kernel_Sys  
  34. Management_Tools      Math_Library          Menu                  
  35. Message_Handling      Metrics               Miscellaneous_Tools   
  36. NOSC_Tools            Online_Documentation  Pager                 
  37. Pointers              Pretty_Printers       Program_Stubber       
  38. Spelling_Checkers     Starter_Kit           Style_Checkers        
  39. Virtual_Terminal      WIS-ADA_Tools         
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52. Level  0 Menu: (Exit, Selection)  compo
  53. -- This prompt indicates that the user may exit or select a topic.
  54. -- To exit, the command "EXIT" or "X" followed by a RETURN may
  55. -- be issued.  Case is never significant.  To select a topic, the
  56. -- user need only type enough characters to make it unique.  If not
  57. -- unique, the first topic in the list matching the user's characters
  58. -- will be selected.  All user input is terminated by a RETURN.
  59. -- In this example, the user input is "compo", which matches "Components"
  60.  
  61. 1 Components
  62.  
  63. PD:<ADA.COMPONENTS>
  64.  
  65.          This  is  the  components subdirectory.  Software components,
  66. including general-purpose  procedures,  packages,  and  generics,  are
  67. stored  here.  Examples are:  math packages, TERMCAP routines, generic
  68. linked list packages, and dynamic string packages.
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84. Level  0 Topic: 1 Components (Print, Exit, Up, Next, Menu)  
  85. -- This prompt indicates that the user has the following options:
  86. --     "P" or "PRINT" will print this section out to a file; "this section"
  87. --        is this screen and all screens following, and does not
  88. --        include subtopics
  89. --    "X" or "EXIT" will exit the HELP program
  90. --    "U" or "UP" will take the user up to the previous level (the
  91. --        top-level menu in this case)
  92. --    "N" or "NEXT" or just the RETURN key will take the user to
  93. --        the next screen (in this case, I struck the RETURN key)
  94. --    "Menu" indicates that a menu of subtopics under this topic
  95. --        is available, and entering "M" or "MENU" will display this
  96. --        menu
  97.  
  98.    PD:<ADA.COMPONENTS>
  99.                   Bytes(SZ)  
  100.  
  101.  ABSTRACT.PRO.1   3433(7)    
  102.    .SRC.1         572620(7)  
  103.  CAS2.ADA.2       6942(7)    
  104.    .PRO.1         2452(7)    
  105.  CAS3.ADA.3       8259(7)    
  106.    .PRO.4         2755(7)    
  107.  CLI.CMM.1        4645(7)    
  108.    .DIS.1         92(7)      
  109.    .PRO.1         3745(7)    
  110.    .SRC.1         30039(7)   
  111.  COUNTADA.CMM.1   1313(7)    
  112.    .PRO.1         4139(7)    
  113.    .SRC.1         4587(7)    
  114.  CSET.PRO.2       3227(7)    
  115.    .SRC.2         17638(7)   
  116.  DSTR1.ADA.1      8598(7)    
  117.    .PRO.1         3014(7)    
  118.  DSTR2.ADA.1      14129(7)   
  119.    .PRO.1         2993(7)    
  120. Level  0 Topic: 1 Components (Print, Exit, Up, Next, Last, Menu)  m
  121. -- The "next" screen is a directory listing of all files under the
  122. -- "Components" directory in the Ada Repository.  A "Last" prompt
  123. -- has been added to our prompt line, indicating that there are one or
  124. -- more screens in front of the current screen and typing "L" or "LAST"
  125. -- will back us up.  When we are on the last screen of a section,
  126. -- the "Next" portion of the prompt line disappears.  Also, when a
  127. -- Menu is being displayed, the commands in the prompt override, so
  128. -- if there is a Menu entry called "Exit", it can be referenced by
  129. -- typing "EX" or "EXI" or "E", but typing "EXIT" will run the exit
  130. -- function and knock the user out of the HELP program.
  131. --
  132. -- In this example, I struck "m", causing a subordinate menu to display:
  133.  
  134. Abstractions          CAS2                  CAS3                  
  135. CLI                   CAS                   Character_Set         
  136. Dynamic_String        Dynamic_String_2      Dynamic_String_3      
  137. FGET                  Garbage_Collection    IO_Support            
  138. Limited_Prioritized_  Linked_list           Message_IO            
  139. Parser                Permutations_Class    Prioritized_Queue     
  140. Quick_Sort            Safe_IO               SYSDEP_DEC            
  141. SYSDEP_DG             Singly_Linked_List    Stack                 
  142. TBD                   VDT100                Variable_Length_Dire  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157. Level  1 Menu: (Exit, Up, Selection)  abs
  158. -- Details of these pieces of software are now available.  This is
  159. -- a menu, so our options are few.  Like topic screens, menus may
  160. -- extend beyond one screen (more than 60 menu items) -- when this
  161. -- occurs, the "Next" and "Last" portions of the prompt may appear.
  162. --
  163. -- In this example, I typed "abs", selecting the "Abstractions" topic:
  164.  
  165. 2 Abstractions
  166. Author       : Bill Toscano, Michael Gordon
  167.              : Intermetrics, Inc, 
  168.  
  169. Keywords     : Components, Reusable Software Components
  170.  
  171. Abstract     :
  172.  ABSTRACTIONS contains a number of low-level
  173. support routines which are used by NOSC tools
  174. created by Intermetrics.  Several routines are
  175. of general utility.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188. Level  1 Topic: 2 Abstractions (Print, Exit, Up)  u
  189. -- "Up", which is invoked by the "u" command that I typed, brings
  190. -- me back up to the menu:
  191.  
  192. Abstractions          CAS2                  CAS3                  
  193. CLI                   CAS                   Character_Set         
  194. Dynamic_String        Dynamic_String_2      Dynamic_String_3      
  195. FGET                  Garbage_Collection    IO_Support            
  196. Limited_Prioritized_  Linked_list           Message_IO            
  197. Parser                Permutations_Class    Prioritized_Queue     
  198. Quick_Sort            Safe_IO               SYSDEP_DEC            
  199. SYSDEP_DG             Singly_Linked_List    Stack                 
  200. TBD                   VDT100                Variable_Length_Dire  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215. Level  1 Menu: (Exit, Up, Selection)  link
  216. -- "link" followed by a RETURN selects the "Linked_list" topic:
  217.  
  218. 2 Linked_list
  219.  
  220. Author       : Richard Conn
  221.              : Texas Instruments
  222.  
  223. Keywords     :  DOUBLY-LINKED LIST, LIST MANIPULATION
  224.  
  225. Abstract     :
  226.  This package provides a number of routines
  227. which can be used to manipulate a doubly-
  228. linked list.  See the visible section for
  229. a rather complete set of documentation on
  230. the routines.
  231.  
  232.  Each element of the list is of the following
  233. structure:
  234.      RECORD
  235.         contents: element_object;  -- data
  236.         next:     element_pointer; -- ptr
  237.         previous: element_pointer; -- ptr
  238.      END RECORD;
  239.  
  240.  
  241. Level  1 Topic: 2 Linked_list (Print, Exit, Up)  x
  242. -- Finally, "x" exits the HELP program
  243.  
  244.