home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / pc / progrmng / inhlp11.lzh / INSTAHLP.DOC < prev   
Text File  |  1988-02-26  |  15KB  |  331 lines
  1.  
  2.  
  3.                        Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988
  4.                               Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy
  5.  
  6.  
  7.           This package is intended for use with the Clipper Summer '87
  8.      compiler.  Use of any previous versions will NOT work.
  9.  
  10.           If you like what you see and want to use it in your programs,
  11.      I am asking $25 (U.S.) or your word as a fellow developer that the
  12.      library will either be destroyed or given to someone else to look
  13.      at.  An extra $25 (U.S.) and you will receive a copy of the source
  14.      to modify to your heart's content!!  Also, please feel free to
  15.      distribute this library to your friends/enemies.  And as always,
  16.      any comments, suggestions, death threats, etc... are welcome and
  17.      will be considered.
  18.  
  19.      Thanks, Richard.
  20.  
  21.           OK, on to more important subjects.  This package contains the
  22.      following programs/files:
  23.  
  24.           1) INHP11.LIB    --  The Instant Help v1.1 Library.
  25.           NOTE:  The HELP.* files are NOT part of the original package.
  26.                  They will be made if not currently present.
  27.           2) HELP.DBF      --  The database for your help screens.
  28.           3) HELP.DBT      --  The memo file for HELP.DBF.
  29.           4) HELP.NTX      --  The index created by HELP and INSTAHLP.
  30.           5) HLTEST.PRG    --  The demo test program.  Feel free to look
  31.                                at it to see how easy it is to use the
  32.                                system.  This program needs to be
  33.                                compiled by CLIPPER S'87 before you can
  34.                                link it.
  35.           6) INSTAHLP.DOC  -- This file you're reading right now.
  36.  
  37.      To link and run the demo;
  38.  
  39.           1) Compile HLTEST.PRG with CLIPPER S'87.
  40.           2) Link using CLIPPER.LIB, EXTEND.LIB and INHP11.LIB
  41.  
  42.              With DOS LINK:
  43.                 link hltest,,,clipper extend inhp11
  44.  
  45.              With PLINK86:
  46.                 PLINK86 FI HLTEST LIB CLIPPER, EXTEND, INHP11
  47.  
  48.      Execute HLTEST and enjoy!
  49.  
  50.      To link with your program, you will need to do the following:
  51.  
  52.          1)  Somewhere (I do it at the beginning) in your program put
  53.              the following instructions:
  54.  
  55.              external instahlp, help  && For making help screens.
  56.              set key 291 to instahlp  && Alt-H triggers creating help.
  57.  
  58.          This will cause link/plink86 to look for the modules INSTAHLP
  59.          and HELP in the library and set ALT-H to INSTAHLP.
  60.  
  61.  
  62.  
  63.                                     Page 1                                    Page 1                                    Page 1                                    Page 1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                        Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988
  70.                               Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy
  71.  
  72.  
  73.           2)  Make sure you erase HELP.DBF, HELP.DBT and HELP.NTX from
  74.               the current directory (Of course, don't erase HELP if you
  75.               are currently working on it) and the programs will create
  76.               it the first time you press ALT-H.  At any time if you
  77.               suspect an index error, simply erase HELP.NTX and the
  78.               programs will re-create it.
  79.  
  80.  
  81.           3)  When you are done creating your help screens and are ready
  82.               to give the program to your customer, simply remove
  83.               "instahlp" from the external statement and delete (I
  84.               usually comment it out) the instruction -- set key 291 to
  85.               instahlp.  When the customer hits ALT-H, nothing will
  86.               happen, but when he hits F1 -- WOW!!
  87.  
  88.  
  89.                            **  RUN INSTRUCTIONS  **
  90.  
  91.           As you probably have figured out by now, to activate the
  92.      program, press ALT-H (assuming you have "set key 291 to instahlp"
  93.      in your program).  A box will appear in the upper left corner of
  94.      your screen.  Enter the screen number (1-9).  A bigger box will
  95.      appear to edit/add the help screen specific information.
  96.  
  97.                      ┌─────────────────────────────────┐
  98.                      │     Program:  HLTEST            │
  99.                      │    Variable:  VAR1              │
  100.                      │   Box Chars:                    │
  101.                      │   Box Color:  R                 │
  102.                      │  Text Color:  B+                │
  103.                      │      Header:  Help for screen   │
  104.                      │      Footer:  PgDn, Or any ke   │
  105.                      │  Head Color:  W+                │
  106.                      │  Foot Color:  RG+               │
  107.                      │      Shadow:  Y                 │
  108.                      │   Sh. Color:  N/N               │
  109.                      │     Overlay:  Y                 │
  110.                      │  Pause Time:  10                │
  111.                      └─────────────────────────────────┘
  112.  
  113.            NOTE:  At anytime while editing, the following keys are
  114.                   available:
  115.                   <ESC>    Abort.
  116.                   <ENTER>  Accept current field editing.
  117.                   <CTRL-U> Undo changes of current field.
  118.                   <HOME>   Go to beginning of current field.
  119.                   <PGDN>   Complete all fields displayed for editing.
  120.  
  121.         Program:  The name of the program when ALT-H was pressed.
  122.        Variable:  The name of the variable when ALT-H was pressed.
  123.                   NOTE:  There are different uses for this variable.
  124.                          By leaving this information blank, the help
  125.                          screen you define here will be a GENERIC help
  126.                          screen for that procedure.
  127.  
  128.  
  129.                                     Page 2                                    Page 2                                    Page 2                                    Page 2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                        Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988
  136.                               Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy
  137.  
  138.  
  139.                          This allows you to have a combination of
  140.                          specific and non-specific help for that
  141.                          screen/procedure.  This means if you have three
  142.                          variables in an edit screen and you define a
  143.                          specific help for VAR1 and a non-specific help
  144.                          for VAR2, when F1 is pressed on VAR1, the
  145.                          specific help you wrote will come up.  But when
  146.                          the user presses F1 on VAR2 OR VAR3, the
  147.                          generic help you defined for VAR2 appears on
  148.                          BOTH!  You may edit the generic help on any
  149.                          variable that is not specific on that
  150.                          screen/procedure.  For this reason, I suggest
  151.                          (it is also good programming etiquette) to have
  152.                          each entry/edit screen in it's own procedure.
  153.                          This would allow you to make a generic help for
  154.                          each screen.  If you define more than one
  155.                          screen per procedure, and have a generic help,
  156.                          it will appear on ANY wait state in that
  157.                          procedure.
  158.       Box Chars:  Enter Box chars.  Clipper's BOX command is used, so
  159.                   define the characters from upper-left corner clockwise
  160.                   to the left vertical line.  Look at you Clipper manual
  161.                   at the @ BOX command description for ideas.
  162.       Box Color:  Any valid clipper color statement. -- No syntax check.
  163.      Text Color:  Color for text inside of box.  Refer to Box Color.
  164.          Header:  Message to be displayed at top of help box.
  165.          Footer:  Message to be displayed at bottom of help box.
  166.                   I usually have this message say something like,
  167.                   Press any key...; Press PgUp or any key... (for
  168.                   screens that have a screen before it); Press PgUp,
  169.                   PgDn or any key... (for screens that have screens
  170.                   above and below them); or Press PgDn or any key...
  171.                   (for the first screen if there is a screen 2, 3,
  172.                   etc...).  NOTE: This system uses PgUp to go up a
  173.                   screen (ex; from screen 2 to 1) and PgDn to go down a
  174.                   screen (ex; from screen 1 to 2).  If PgUp is pressed
  175.                   on Screen 1, the help is finished.  If PgDn is pressed
  176.                   on the last defined screen (Upper limit of 9, lower
  177.                   limit of 1), the help is finished.
  178.      Head Color:  Color for Header Message.  Must be Clipper color
  179.                   statement.
  180.      Foot Color:  Color for Footer Message.  Must be Clipper Color
  181.                   Statement.
  182.          Shadow:  Y/N -- Display shadow under box?
  183.       Sh. Color:  Color for shadow.  Only valid if Shadow: = Y.
  184.                   ASCII Character 176 (░)is used for the shadow.  This
  185.                   character is a box with half the pixels defined in the
  186.                   foreground color, and the other half in the background
  187.                   color.  This can give a "shadow" effect with the right
  188.                   color combinations.  Experiment!
  189.         Overlay:  Y/N -- Y = Overlay help, N = Clear screen before
  190.                   displaying this help AND after.  Makes a "loner" help
  191.                   screen.
  192.  
  193.  
  194.  
  195.                                     Page 3                                    Page 3                                    Page 3                                    Page 3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                        Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988
  202.                               Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy
  203.  
  204.  
  205.      Pause Time:  Amount of time to wait for a key-press from user.
  206.                   An amount of 1 displays until a key-press.
  207.  
  208.  
  209.           Once the specific information is filled in, answer Y to OK?
  210.      and a full cursor will appear.  Move the cursor to where you want
  211.      the UPPER LEFT corner of the help box to appear.  Press <ENTER>.
  212.      Then move the cursor again to where you would like the LOWER RIGHT
  213.      corner of the help box to be.  Press <ENTER>.  The box will be
  214.      drawn and you will be placed into a memo to edit inside the help
  215.      box.  Press ALT-H when you are finished editing.  The menu at the
  216.      bottom of the screen gives you the choices:
  217.  
  218.  
  219.      F2 - Toggle Screens :  Allows viewing screen you are writing help
  220.                             for.
  221.      F3 - Delete         :  Asks if you want to delete current help
  222.                             screen.  Answer Y/N.
  223.      ALT-H - Save-Exit   :  Saves current help screen and exists back to
  224.                             your program.
  225.      ESC - Abort         :  Aborts current editing of help memo and
  226.                             exists back to your program.  NOTE:  When
  227.                             you answer Y to OK? when editing the
  228.                             Specific Information,  the Specific
  229.                             Information is then saved.  You must press
  230.                             ESC when editing that information to abort
  231.                             your changes and exit back to your program.
  232.      F4 - Move Window    :  Use the cursor keys and move your help
  233.                             window to another part of the screen.
  234.  
  235.           Enjoy the system and let me know how you like it.  I have put
  236.      a lot of thought and energy into trying to create a very easy and
  237.      professional help system.  I hope I have met a need in the
  238.      programming/development department.  Let me know what you think.
  239.  
  240.      NOTE:  This library contains a sub set of Jason Matthews PROCLIP2
  241.             functions.  I very HIGHLY endorse his library.  I use it
  242.             extensively.  If you currently use the library, you will
  243.             probably get some link warning messages.  If using MS LINK,
  244.             use the /NOE option to avoid these messages.  If using
  245.             PLINK86, you will just have to ignore them.
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                     Page 4                                    Page 4                                    Page 4                                    Page 4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                        Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988                       Instant Help - INSTAHLP (c) 1988
  268.                               Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy                              Richard A. Murphy
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.                             Registration Form for:
  285.                           Instant Help - Version 1.1
  286.  
  287.  
  288.                       Please Send To:  Richard A. Murphy
  289.                                        3162 Prosser Ave.
  290.                                        Akron, OH  44319
  291.                                        (216) 645-6707
  292.  
  293.  
  294.                          Name:  ____________________
  295.                       Company:  ____________________
  296.                                (If applicable)
  297.                          Addr:  ____________________
  298.                          Addr:  ____________________
  299.                          City:  ____________________
  300.                         State:  ____________________
  301.                           Zip:  ____________________
  302.  
  303.  
  304.  
  305.      Please Check One:
  306.  
  307.      __  Inclosed is my check for $25 for the registration fee.
  308.  
  309.      __  Inclosed is my check for $50 for the registration fee AND
  310.          the source code for my own use/modification.
  311.  
  312.          All registered persons will receive a confirmation of their
  313.      registration from me and will be informed of any changes/updates,
  314.      and if at all possible, receive free updates.
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                     Page 5                                    Page 5                                    Page 5                                    Page 5
  328.  
  329.  
  330.  
  331.