home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / pascal / library / dos / help / tphelp10 / hlp.doc next >
Encoding:
Text File  |  1990-02-14  |  7.5 KB  |  201 lines
  1.                            Turbo-Fake Help Function
  2.  
  3.                                   Version 1.0
  4.  
  5.                                 By Kevin Beiter
  6.                                    2/14/1990
  7.  
  8.  
  9.      This is a program to write help screens for your own Turbo Pascal
  10. procedures and functions.  It does not use Turbo Pascal's help function,
  11. but it includes a TSR program that works just like it.  Hence the name,
  12. Turbo-Fake.
  13.  
  14.      What you must do, is make the help screen for each procedure or function,
  15. and add the procedure names, and the page numbers on which they are located,
  16. to the lookup table.  Then, when you are in the integrated environment, just
  17. move the cursor to your procedure name, and press LeftShift-F1.  Your help
  18. screen will be displayed, which can show the syntax of that procedure, and can
  19. reference you to help on other procedures or topics.
  20.  
  21.  
  22. Turbo-Fake consists of the following files:
  23.  
  24.  
  25.      HLPPOP.EXE    :  Turbo-Fake Help program
  26.      HLP.EXE       :  Non-resident version of HLPPOP.EXE
  27.      HLPMAKE.EXE   :  Turbo-Fake Help Maker program
  28.      HLPLOKUP.EXE  :  Turbo-Fake Help lookup table
  29.      HLP.HLP       :  Turbo-Fake Help data file
  30.      HLP.IDX       :  Turbo-Fake Help lookup table
  31.      HLPCOLOR.DAT  :  File containing your color preferences
  32.  
  33.  
  34.  
  35. I.HLPMAKE.EXE
  36.  
  37.  
  38.      This is the program you use to make your help screens.  Help screens are
  39. made by typing them in, highlighting references to help on other topics
  40. (procedures,units, etc.), and adding those reference names to the lookup table.
  41.  
  42.      Words that are highlighted in HLPMAKE, are words that the user can
  43. position a highlight bar upon and view the help about, when HLPPOP or HLP is
  44. running.  Words that are highlighted in HLPMAKE, are NOT in the lookup table,
  45. until you specifically put them there.
  46.  
  47.      Words can be added to the lookup table by executing HLPLOKUP.  This can
  48. be done from HLPMAKE by pressing F1.
  49.  
  50.      Help on any given topic or procedure, can be multiple pages.  All that
  51. you must do, is press F7, and type in the corresponding page numbers of the
  52. help screens that should display when you press PgUp/PgDn in HLPPOP or HLP.
  53.  
  54.      The colors for HLPPOP and HLP can be changed by pressing F9.  The new
  55. colors will be displayed in HLPMAKE as you change them.
  56.  
  57.  
  58.   Key definitions for HLPMAKE:
  59.  
  60.   F1 : Execute HLPLOKUP.  See the section about HLPLOKUP
  61.   F2 : Save the current page of help.
  62.   F3 : Load a page of help.
  63.   F4 : Make a new page of help.
  64.   F5 : Highlight a word so it's help screen can be looked up from HLPPOP/HLP.
  65.   F6 : Remove the highlighted area that the cursor is on.
  66.   F7 : Change the help pages that will be displayed when PageUp and PageDown
  67.        are pressed in HLPPOP and HLP.  If they are zero, or the same as the
  68.        current page, pressing PageUp and PageDown in HLPPOP/HLP, will stay
  69.        on the current page.
  70.   F8 : Clear the text and/or highlighted areas on the page.
  71.   F9 : Change the default color set.
  72.   F10: Displays a help screen about the function keys.
  73.   Ctrl-Y deletes the current line of text.
  74.   PgUp loads previous page of help.
  75.   PgDn loads next page of help.
  76.   INSERT turns insert mode on and off.
  77.   ESC exits the program
  78.  
  79.      HLPMAKE beeps whenever a page is saved.  Also, there can be a maximum of
  80. 30 different areas highlighted on any one page.
  81.  
  82.      The color set is stored in the file HLPCOLOR.DAT, and the default colors
  83. are the same as the default colors for Turbo Pascal 5.5.
  84.  
  85.      Although it is not necessary to know the structure of the help data file
  86. to use Turbo-Fake Help, it is stored in the file HLP.HLP which is a file of
  87. the following Pascal type:
  88.  
  89. PageType = Record
  90.              Info : Array[1..660] of Byte;
  91.              PageUp,PageDown,TotalLookups : Integer;
  92.              Lookup : Array[1..30] of Record
  93.                                         X,Y,Len : Integer;
  94.                                       End;
  95.            End;
  96.  
  97.  
  98. II.HLPLOKUP.EXE
  99.  
  100.      This is the program used to make the lookup table.  What you must do, is
  101. type in the words can be looked up, and the pages of help they are located on.
  102. This program can be executed by pressing F1 in HLPMAKE.
  103.  
  104.      If you try to save the same lookup name twice, in different records, an
  105. error message will display.  Also, you can find a name in the lookup table, by
  106. typing in something close to it, and pressing F3.
  107.  
  108.      Key definitions for HLPLOKUP:
  109.  
  110.      F2    : Save the current record
  111.      F3    : Find the name closest to the name typed in.
  112.      F4    : Clear the entry fields so a new record can be added.
  113.      F6    : Delete the current record.
  114.      PgDn  : Find the next record alphabetically
  115.      PgUp  : Find the previous record alphabetically
  116.      ESC   : Exit
  117.  
  118.      Names can only be 25 letters long, and like HLPMAKE, HLPLOKUP beeps when
  119. a record is saved.  All entries are in capital letters, because Turbo-Fake Help
  120. isn't case sensitive.  The lookup table is stored in the file HLP.IDX, which is
  121. a file of the following Pascal type:
  122.  
  123. RecType = Record
  124.             Name : String[25];
  125.             Page : Integer;
  126.           End;
  127.  
  128.      Again, knowing the file structure is not necessary to use Turbo-Fake Help,
  129. but is provided for those interested.
  130.  
  131.  
  132. III.HLPPOP.EXE
  133.  
  134.      This is a memory resident program that is used to pop up the help screens
  135. that have been created with HLPMAKE.EXE.  It is activated by pressing
  136. LeftShift-F1.
  137.  
  138.      When you press LeftShift-F1, if the cursor is on a word that is in the
  139. lookup table, the help for that word will be displayed.  If not, the first
  140. page of the help file will be shown.  This page is intended for an index of
  141. some sort, although you can put whatever you like there.
  142.  
  143.      Key definitions for HLPPOP:
  144.  
  145.      F1     : Page 1 (index)
  146.      PgUp   : View previous page of help.
  147.      PgDown : View next page of help.
  148.      Arrows : Position the highlight bar
  149.      ENTER  : Show help on the highlighted word.
  150.      ESC    : Exit
  151.  
  152.      There are a couple bugs/problems with using HLPPOP.
  153.  
  154.      1.   If you press LeftShift-F1 to activate it, during execution of
  155.           any program written in Turbo Pascal, your computer will most likely
  156.           freeze up.  It will work fine from the integrated environment, as
  157.           long as you are just editing when you activate it.
  158.  
  159.      2.   If you activate it while running HLPMAKE.EXE, HLPLOKUP.EXE, or
  160.           HLP.EXE, your computer will freeze up.  That follows from the first
  161.           problem, since all these programs were written in Turbo Pascal.
  162.  
  163.      It can be removed from memory by typing HLPPOP /R in DOS.
  164.  
  165.  
  166. IV.HLP.EXE
  167.  
  168.      This is a non-memory resident version of HLPPOP.EXE.
  169.  
  170.  
  171. V.MISCELLANEOUS
  172.  
  173.      You can specify the directory in which Turbo-Fake resides, by setting
  174. a DOS environment variable called HLPDIR.  The programs will look for the
  175. data files in that directory.  If there is no HLPDIR set, they will look
  176. in the current directory.
  177.  
  178.       When you set HLPDIR, make sure you have a backslash ("\") at the end of
  179. the directory name.  For example,
  180.  
  181.               SET HLPDIR=C:\TP55\HLP\
  182.  
  183.  
  184.      Included is a sample help datafile and lookup table which you can use to
  185. experiment with.  To make your own help files, delete the HLP.HLP and HLP.IDX.
  186.  
  187.  
  188.  
  189. This is Public Domain, so feel free to copy it.
  190.  
  191.  
  192. Any suggestions or comments can be sent to:
  193.  
  194.                Kevin Beiter
  195.                3829 Logans Ferry Road
  196.                Pittsburgh, PA  15239
  197.  
  198.                Email : kb36+@andrew.cmu.edu(internet)
  199.  
  200.  
  201.