home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / INHP12.ZIP / INSTAHLP.DOC < prev    next >
Encoding:
Text File  |  1988-03-06  |  37.3 KB  |  793 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.            Disclaimer:  I know it doesn't make you very confident to see
  8.                         the disclaimer as the first thing in the
  9.                         documentation, but...
  10.  
  11.                         The author or his company are not responsible
  12.                         for any damages implied or real to your programs
  13.                         or data as a result of the use of this system.
  14.  
  15.            However:     These programs have been beta tested in real
  16.                         life applications, and to the best of my
  17.                         ability are free from any harmful side-effects
  18.                         that may result in loss or corruption of data or
  19.                         programs.
  20.  
  21.  
  22.  
  23.                              *** Table of Contents ***
  24.  
  25.            Disclaimer ..............................................  1
  26.            Introduction ............................................  2
  27.            Linking and Running HLTEST.PRG ..........................  3
  28.            Run Instructions ........................................  4
  29.            Parameters Screen .......................................  4
  30.            Help Text Editing Keys ..................................  8
  31.            General Discussion ......................................  9
  32.            Exceptions to Instant Help Version 1.2 .................. 10
  33.            File Structure of HELP.DBF .............................. 11
  34.            Acknowledgment to PROCLIP2.LIB .......................... 11
  35.            Registration form for Instant Help System Version 1.2 ... 12
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  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.                 This package is intended for use with the Clipper Summer
  74.            '87 compiler.  Use of any previous versions will NOT work.
  75.  
  76.                 If you like what you see and want to use it in your
  77.            programs, I am asking $25 (U.S.) or your word as a fellow
  78.            developer that the library will either be destroyed or given
  79.            to someone else to look at.  An extra $25 (U.S.) and you will
  80.            receive a copy of the source to modify to your heart's
  81.            content!!  You know where people go who STEAL!!  Also, please
  82.            feel free to distribute this library to your friends/enemies.
  83.            And as always, any comments, suggestions, death threats,
  84.            etc... are welcome and will be considered.
  85.  
  86.            Thanks,
  87.  
  88.  
  89.            Richard.
  90.  
  91.                 OK, on to more important subjects.  This package
  92.            contains the following programs/files:
  93.  
  94.                 1) INHP12.LIB    --  The Instant Help Version 1.2
  95.                                      Library.
  96.                    NOTE:  The HELP.* files are NOT part of the original
  97.                           package.  They will be made if not currently
  98.                           present when ALT+H is pressed for the first
  99.                           time when you are creating help.
  100.                 2) HELP.DBF      --  The database for your help screens.
  101.                 3) HELP.DBT      --  The memo file for HELP.DBF.
  102.                 4) HELP.NTX      --  The index created by HELP and
  103.                                      INSTAHLP.PRG.
  104.                 5) HLTEST.PRG    --  The demo test program.  Feel free
  105.                                      to look at it to see how easy it is
  106.                                      to use the system.  This program
  107.                                      needs to be compiled by CLIPPER
  108.                                      S'87 before you can link it.
  109.                 6) HLPEXC.PRG    --  The program for  exceptions.  To be
  110.                                      included in programs that use the
  111.                                      inkey() statement and MEMOEDIT (see
  112.                                      exceptions discussion below).
  113.                 7) INSTAHLP.DOC  --  The file you're reading right now.
  114.  
  115.            NOTE:  If your package does NOT contain the HELP.DBF,
  116.                   HELP.DBT and HLTEST.PRG, you need to download
  117.                   IN12DEMO.ARC from your bulletin board in order to run
  118.                   the demo.  If you are unfamiliar with this system, I
  119.                   highly recommend down-loading and running the demo.
  120.                   If your package does NOT contain INHP12.LIB, then you
  121.                   MUST download INHP12.ARC from your bulletin board in
  122.                   order to run the demo OR use the system.
  123.  
  124.  
  125.  
  126.  
  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.  
  140.                           *** To Link and Run the Demo ***
  141.  
  142.                 1) Compile HLTEST.PRG with CLIPPER S'87.
  143.                 2) Link using CLIPPER.LIB, EXTEND.LIB and INHP12.LIB
  144.  
  145.                    With DOS LINK:
  146.                       link hltest,,,clipper extend inhp12
  147.  
  148.                    With PLINK86:
  149.                       PLINK86 FI HLTEST LIB CLIPPER, EXTEND, INHP12
  150.  
  151.            Execute HLTEST and enjoy!
  152.  
  153.            To link with your program, you will need to do the following:
  154.  
  155.                1)  Somewhere (I do it at the beginning) in your program
  156.                    put the following instructions:
  157.  
  158.                    external instahlp, help  && For making help screens.
  159.                    set key 291 to instahlp  && ALT+H triggers creating
  160.                                                help.
  161.  
  162.                This will cause link/plink86 to look for the modules
  163.                INSTAHLP.OBJ and HELP.OBJ in the library and will set
  164.                ALT+H to INSTAHLP.
  165.  
  166.                 2)  Make sure you erase HELP.DBF, HELP.DBT and HELP.NTX
  167.                     from the current directory (Of course, don't erase
  168.                     HELP if you are currently working on it) and the
  169.                     programs will create it the first time you press
  170.                     ALT+H.  At any time if you suspect an index error,
  171.                     simply erase HELP.NTX and the programs will re-
  172.                     create it.
  173.  
  174.                 3)  When you are done creating your help screens and are
  175.                     ready to give the program to your customer, simply
  176.                     remove "instahlp" from the external statement and
  177.                     delete (I usually comment it out) the instruction --
  178.                     set key 291 to instahlp.  When the customer hits
  179.                     ALT+H, nothing will happen, but when he hits F1 --
  180.                     WOW!!
  181.  
  182.  
  183.               A more in-depth discussion follows the RUN Instructions.
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  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.                               **  RUN INSTRUCTIONS  **
  206.  
  207.                 As you probably have figured out by now, to activate the
  208.            program, press ALT+H (assuming you have "set key 291 to
  209.            instahlp" in your program).  When ALT+H is pressed in a
  210.            "wait" state, a box will appear in the upper left corner of
  211.            your screen.  Enter the screen number you wish to edit (1-9).
  212.            If a generic help (see Variable: below) is defined, the
  213.            question Specific / Generic: will appear.  Press "G" if you
  214.            wish to edit the generic help screen, or "S" if you wish to
  215.            create a specific help screen for that variable.  The
  216.            Specific / Generic: question will ONLY appear on a variable
  217.            that does not have a specific help defined (see Variable:
  218.            below).  Next, a bigger box (the Parameters Screen) will
  219.            appear to add the help screen specific information.  If the
  220.            help screen you are editing already exists, the Help Text
  221.            will appear for editing first.  You must then press ALT+F5 to
  222.            edit the Parameters Screen (refer to Help Text Editing Keys
  223.            below).
  224.  
  225.                              *** Parameters Screen ***
  226.  
  227.                         ┌─────────────────────────────────┐
  228.                         │     Program:  HLTEST            │
  229.                         │    Variable:  VAR1              │
  230.                         │   Box Chars:  ░░░░░░░░          │
  231.                         │   Box Color:  R/R               │
  232.                         │  Text Color:  G+                │
  233.                         │      Header:  [ Help for scre   │
  234.                         │      Footer:  [ PgDn, Or any    │
  235.                         │  Head Color:  W+                │
  236.                         │  Foot Color:  W+                │
  237.                         │      Shadow:  Y                 │
  238.                         │   Sh. Color:  R/N               │
  239.                         │     Overlay:  Y                 │
  240.                         │  Pause Time:  10                │
  241.                         │                                 │
  242.                         │  *** Press ALT+H For Help ***   │
  243.                         └─────────────────────────────────┘
  244.  
  245.                  NOTE:  At anytime while editing, the following keys are
  246.                         available:
  247.                         <ALT>+<F1> Help Screen.
  248.                         <ESC>      Abort.
  249.                         <ENTER>    Accept current field editing.
  250.                         <CTRL-U>   Undo changes of current field.
  251.                         <HOME>     Go to beginning of current field.
  252.                         <PGDN>     Complete all fields displayed for
  253.                                    editing.
  254.                         <INS>      Toggle Insert/Overlay text modes.
  255.                                    NOTE:  When <ENTER> is pressed,
  256.                                           Insert mode is automatically
  257.                                           off.
  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.                         *** Parameters Screen Continued ***
  272.  
  273.            Program:  The name of the program when ALT+H was pressed.
  274.  
  275.            Variable:  The name of the variable when ALT+H was pressed.
  276.               Valid entries are the variable name calling Instant Help,
  277.               or an empty field.  There are different uses for this
  278.               parameter.  By leaving this information blank, the help
  279.               screen you define here will be a GENERIC help screen for
  280.               that procedure.  This allows you to have a combination of
  281.               specific and non-specific help for that screen/procedure.
  282.               This means if you have three variables in an edit screen
  283.               and you define a specific help for VAR1 and a non-specific
  284.               help for VAR2, when F1 is pressed on VAR1, the specific
  285.               help you wrote will come up.  But when the user presses F1
  286.               on VAR2 OR VAR3, the generic help you defined for VAR2
  287.               appears on BOTH!  You may edit the generic help on any
  288.               variable that does not have specific help for that
  289.               screen/procedure.  For this reason, I suggest (it is also
  290.               good programming etiquette) to have each entry/edit screen
  291.               in it's own procedure.  This would allow you to make a
  292.               generic help for each screen.  If you define more than one
  293.               screen per procedure, and have a generic help, it will
  294.               appear on ANY wait state in that procedure.  All of this
  295.               is with the exception of the "WAIT" and "INKEY()" command
  296.               (see exceptions discussion below).  Since Clipper will not
  297.               send a variable name from a "WAIT" statement even if you
  298.               have the line "WAIT TO VAR" in your program, the help
  299.               system will ignore any attempts for help, or to create
  300.               help from this wait state.  If you wish to create a
  301.               specific help on a variable that currently uses a generic
  302.               help, answer "S" to the question Generic / Specific: that
  303.               appears after Screen: when a generic help exists.  To turn
  304.               a generic help into a specific help, simply insert the
  305.               variable name that you are editing into the Variable:
  306.               prompt which is currently blank (since Instant Help will
  307.               NOT allow a different variable name to be entered other
  308.               than the variable that has called Instant Help, by
  309.               entering any characters into the Variable: field, the
  310.               system will automatically insert the correct variable
  311.               name).
  312.  
  313.            Box Chars:  Enter Box chars.  Clipper's BOX command is used,
  314.               so define the characters from upper-left corner clockwise
  315.               to the left vertical line.  Look at your Clipper Manual
  316.               for the @ BOX command description for ideas.  Hint: try
  317.               using the characters 176 (default), 177 and 178 (enter in
  318.               the field by pressing ALT+176...) in your boxes.  Since
  319.               these characters are part foreground and part background,
  320.               you can create colors that are NOT part of the computer's
  321.               color scheme by "blending" colors (See Box Color: below).
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                        Page 5                                       Page 5                                       Page 5                                       Page 5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  334.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  335.  
  336.  
  337.            Box Color:  Color statement for Color Monitor;Color statement
  338.               for Black & White monitor.  Ex; R/N;W/N defines Red/Black
  339.               for color monitors, and White/Black for Black & White
  340.               monitors.  No syntax checking is preformed on ANY color
  341.               statements.  Color Shading:  If you use the example above
  342.               of using ASCII 176, 177 or 178 as your box characters, try
  343.               using "R/GR+" (RED/YELLOW) as your box color or "BG+/G"
  344.               (Bright CYAN/GREEN) or any other color combinations.  The
  345.               same applies to the "SHADOW" colors since ASCII Character
  346.               176 is used as the "Shadow" (see Shadow: for more
  347.               details).
  348.  
  349.            Text Color:  Color for text inside of box.  Refer to Box
  350.                         Color:
  351.  
  352.            Header:  Message to be displayed at the top of the help box.
  353.  
  354.            Footer:  Message to be displayed at the bottom of the help
  355.               box.  I usually have this message say something like,
  356.               Press any key...; Press PgUp or any key... (for screens
  357.               that have a screen before it); Press PgUp, PgDn or any
  358.               key...  (for screens that have screens above and below
  359.               them); or Press PgDn or any key...  (for the first screen
  360.               if there is a screen 2, 3, etc...).  NOTE: This system
  361.               uses PgUp to go up a screen (ex; from screen 2 to 1) and
  362.               PgDn to go down a screen (ex; from screen 1 to 2).  If
  363.               PgUp is pressed on Screen 1, the help is finished.  If
  364.               PgDn is pressed on the last defined screen (Upper limit of
  365.               9, lower limit of 1), the help is finished.
  366.  
  367.               NOTE:  On the Header and Footer messages, what you type is
  368.                      what you get.  For example, if you type "Hit a
  369.                      key", the box will surround your statement without
  370.                      any spaces.  If you type instead, "[ Hit a key ]"
  371.                      or "*** Hit a key ***", it is much more readable
  372.                      for your customer.
  373.  
  374.            Head Color:  Color for Header Message.  Refer to Box Color:
  375.  
  376.            Foot Color:  Color for Footer Message.  Refer to Box Color:
  377.  
  378.            Shadow:  Y/N -- Display a shadow around box?  The shadow is
  379.               displayed by the left vertical box line and under the
  380.               bottom box line to give the appearance of a three-
  381.               dimensional box.
  382.  
  383.            Sh. Color:  Color for shadow (Only valid if Shadow: = Y).
  384.               ASCII Character 176 (░) is used for the shadow.  This
  385.               character is a box with some of the pixels defined in the
  386.               foreground color, and most of them in the background
  387.               color.  This can give a "shadow" effect with the right
  388.               color combinations.  Experiment!  Refer to Box Color:.
  389.  
  390.  
  391.  
  392.  
  393.                                        Page 6                                       Page 6                                       Page 6                                       Page 6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  400.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  401.  
  402.  
  403.            Overlay:  Y/N - "Y" = Overlay help, N = Clear screen before
  404.               displaying this help AND after.  Makes a "loner" help
  405.               screen.
  406.  
  407.            Pause Time:  Amount of time to wait for a key-press from
  408.               user.  An amount of 0 displays until a key-press.
  409.  
  410.            Once the specific information is filled in, answer Y to OK?
  411.            and a full cursor will appear (only on a new screen - refer
  412.            to Help Text Editing Keys below for existing help screens).
  413.            Move the cursor to where you want the UPPER LEFT corner of
  414.            the help box to appear.  Press <ENTER>.  Then move the cursor
  415.            again to where you would like the LOWER RIGHT corner of the
  416.            help box to be.  Press <ENTER>.  The box you defined will
  417.            then be drawn, and you may proceed to edit the help
  418.            information to be displayed when the user presses F1.
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                        Page 7                                       Page 7                                       Page 7                                       Page 7
  460.  
  461.  
  462.  
  463.  
  464.  
  465.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  466.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  467.  
  468.  
  469.                            *** Help Text Editing Keys ***
  470.  
  471.            NOTE: When ALT+H is pressed to call up a Help Screen that
  472.                  already exists, you are placed directly into the Help
  473.                  Text to edit the help displayed to the end-user.  If
  474.                  the screen you enter does NOT exist, then you are sent
  475.                  to define the parameters and the coordinates of the
  476.                  help box.  During editing of the Help Text, the
  477.                  following keys are used:
  478.  
  479.            ALT+F1 - Help Screen:  Displays the Keys that may be pressed
  480.                     during editing of the Help Text.  NOTE: The ALT+KEY
  481.                     keys MAY be pressed while Help is being viewed
  482.                     giving the developer the ability to call up help and
  483.                     press the key he wants to use without having to exit
  484.                     the help screen and then pressing the key he wants
  485.                     to use.
  486.  
  487.            ALT+F2 - Toggle Screens:  Allows toggling between writing
  488.                     help and the viewing of the screen you are writing
  489.                     help for.
  490.  
  491.            ALT+F3 - Delete:  Asks if you want to delete the current help
  492.                     screen (May also be executed from the specific
  493.                     information screen).  Press Y/N.
  494.  
  495.            ALT+F4 - Move Window:  Use the cursor keys and move your help
  496.                     window to another part of the screen.  Press <ENTER>
  497.                     to accept new position, or <ESC> to return to
  498.                     previous position.
  499.  
  500.            ALT+F5 - Edit Parameters:  Calls up the Parameters screen to
  501.                     edit the colors, header, footer, etc.
  502.  
  503.            ALT+F6 - Re-size the Help Screen:  Move the cursor to define
  504.                     the upper left corner of the help screen, and then
  505.                     the lower right corner.  If you have SHADOW as "Y",
  506.                     then be sure to leave a column on the left and a row
  507.                     on the bottom of the help for the shadow, or none
  508.                     will be drawn.  Press <ESC> to abort re-defining the
  509.                     box coordinates.
  510.  
  511.            ALT+H  - Save/Exit:  Saves the current help screen and
  512.                     returns back to your program.
  513.  
  514.            <ESC> -  Abort:  Aborts current editing of the help memo and
  515.                     returns back to your program.  NOTE:  This does NOT
  516.                     abort the specific screen information while you are
  517.                     editing the Help Memo.  To abort the changes to
  518.                     specific information, <ESC> must be pressed before
  519.                     "Y" is answered to OK? after you enter the specific
  520.                     information.  (Press ALT+F3 to delete)
  521.  
  522.  
  523.  
  524.  
  525.                                        Page 8                                       Page 8                                       Page 8                                       Page 8
  526.  
  527.  
  528.  
  529.  
  530.  
  531.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  532.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  533.  
  534.  
  535.            *** General Discussion on Instant Help System Version 1.2 ***
  536.  
  537.                 The following is a discussion of the concepts and design
  538.            of the Instant Help System Version (c) 1.2 and the
  539.            exceptions/bugs of the system.
  540.  
  541.                 This system is based on the fact that creating help can
  542.            and is a very tedious and back-breaking procedure to say the
  543.            least.  In attempts to create an automated help system, this
  544.            program has emerged.  Almost everything that I would want to
  545.            do in a help program is incorporated into this system.  A
  546.            couple of things that I can think of that this system can not
  547.            do is:
  548.                1) Having different colors within the help text
  549.            displayed.  At this point, I don't know if it will ever be a
  550.            feature, and
  551.                2) The ability to save your help screen to a file and
  552.            read it into another help screen.  The latter one is
  553.            currently under development and hopefully will be out within
  554.            a matter of weeks.
  555.  
  556.                 By creating a program that does some fancy stuff which
  557.            this system cannot do, you may "intercept" the help call by
  558.            placing the statement "set key 28 to <myhelp>" in your
  559.            program and if the fancy help is not the one the user wants,
  560.            simply pass the parameters to the HELP.PRG in Instant Help.
  561.  
  562.                 For those of you with Instant Help System Version 1.1,
  563.            the following changes should be made to your help.dbf file to
  564.            ensure capability when editing with version 1.2.  The fields
  565.            BOX_COLOR, TX_COLOR, HD_COLOR, FT_COLOR and SH_COL should be
  566.            changed from a length of 6 to 17.  Not doing this will not
  567.            cause the program to "bomb" out, but you will be unable to
  568.            supply Color;Black/White color combinations within that
  569.            application.
  570.  
  571.                 The only drawback to using a system like this is that 3
  572.            files are used for the help system.  HELP.DBF, HELP.DBT, and
  573.            HELP.NTX.  If you are using DOS 3.3 and above, make sure you
  574.            use the statement "files=??" in your config file if you have
  575.            more than 15 files opened.  Also, use the Clipper S'87 system
  576.            variable "F" to set CLIPPER=F?? to ensure opening your files
  577.            is possible (refer to the Clipper Manual for a better
  578.            explanation).  For DOS 3.2 and below, 15 files is all that is
  579.            possible to open at a time unless you have a special program
  580.            to increase the file capabilities.  Using the statement
  581.            "files=20" will give you the capability of 15 files open at a
  582.            time.  This includes DBF, NTX, and DBT files.  If you have
  583.            more that 12 open at a time when help can be called, you will
  584.            get a system error when help is called.
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.                                        Page 9                                       Page 9                                       Page 9                                       Page 9
  592.  
  593.  
  594.  
  595.  
  596.  
  597.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  598.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  599.  
  600.  
  601.                  *** Exceptions to this system are as follows: ***
  602.  
  603.            1)  The "WAIT" command is NOT supported as a valid wait
  604.                state, since Clipper does NOT send a line number or more
  605.                important, a variable name to the Help System.  Even if
  606.                you have the command "WAIT TO VAR" in your program,
  607.                Clipper will NOT send "VAR" to any program with a SET KEY
  608.                TO statement.
  609.  
  610.            2)  The INKEY(x) statement is NOT a Clipper Wait State, so
  611.                SET KEY TO will not work with an inkey() command.  To
  612.                overcome this problem, I have included a program called
  613.                HLPEXC.PRG (Help Exceptions) which I use to pass the
  614.                necessary parameters to the Help System.  Include this
  615.                program in your programs which use INKEY statements where
  616.                you would want help available at.
  617.  
  618.            3)  The MEMOEDIT function is like the WAIT instruction in
  619.                that it does NOT send the line and the variable being
  620.                edited, only "MEMOEDIT" which is unacceptable because we
  621.                need specific information to make specific help.  The
  622.                program HLPEXC.PRG also includes a user defined function
  623.                to be used with MEMOEDIT to allow help to be defined and
  624.                used.
  625.  
  626.            4)  Any keys re-directed using the SET KEY TO command that
  627.                are used in MEMOEDIT (ex, <SPACE>, right and left arrows,
  628.                etc...) will interfere with the MEMOEDIT command used in
  629.                editing the HELP text.  If these keys are re-defined, you
  630.                may find it necessary to edit the help text in dbase.
  631.                See the Structure of HELP.DBF below for a better idea on
  632.                how to do this.
  633.  
  634.            5)  The ALT+F1 through ALT+F6 and ALT+H keys are defined in
  635.                Instant Help Version 1.2 (c), so any definitions that
  636.                your programs set on these keys will be canceled when
  637.                Instant Help is called.  The ALT+<KEY> combination was
  638.                used so the least likely conflicts would occur between
  639.                Instant Help and your programs.
  640.  
  641.            6)  When using Overlays and PLINK86, make sure that the
  642.                INHP12.LIB is specified BEFORE CLIPPER.LIB and EXTEND.LIB
  643.                since PLINK86 does not know to re-use these libraries
  644.                when looking for some functions that INHP12 uses.  Also,
  645.                since using libraries means that you are running into
  646.                memory problems, know that library functions are loaded
  647.                into the root.  If you experience problems with this,
  648.                either use LIB.EXE with MicroSoft C and extract HELP.OBJ
  649.                , INSTAHLP.OBJ and B_H_HELP.OBJ, or write me and I will
  650.                send those objects for you.  If you use this approach,
  651.                make sure these objects are in a high enough level where
  652.                all programs may access them (usually the level directly
  653.                under the root is necessary).
  654.  
  655.  
  656.  
  657.                                       Page 10                                      Page 10                                      Page 10                                      Page 10
  658.  
  659.  
  660.  
  661.  
  662.  
  663.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  664.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  665.  
  666.  
  667.                      *** Structure for database:  HELP.DBF ***
  668.  
  669.            Field  Field name  Type       Width    Description
  670.            -----  ----------  ----       -----    -----------
  671.                1  V1_2        Character      1    Version Number
  672.                2  PROGRAM     Character     10    Program Name
  673.                3  VARIABLE    Character     12    Variable Name
  674.                4  SCREEN      Character      1    Screen Number
  675.                5  R1          Character      2    Upper Left Row
  676.                6  C1          Character      2    Upper Left Column
  677.                7  R2          Character      2    Lower Right Row
  678.                8  C2          Character      2    Lower Right Column
  679.                9  TEXT        Memo          10    Help Text
  680.               10  BOX         Character      8    Box Characters
  681.               11  BOX_COLOR   Character     17    Box Color
  682.               12  TX_COLOR    Character     17    Help Text Color
  683.               13  HEADER      Character     50    Header Message
  684.               14  FOOTER      Character     50    Footer Message
  685.               15  HD_COLOR    Character     17    Header Message Color
  686.               16  FT_COLOR    Character     17    Footer Message Color
  687.               17  SHADOW      Character      1    Y/N for Shadow
  688.               18  SH_COL      Character     17    Shadow Color
  689.               19  OVERLAY     Character      1    Y/N for Overlay
  690.               20  PAUSE       Character      3    Pause Time in Seconds
  691.            ** Total **                     241
  692.  
  693.  
  694.                 Enjoy the system and let me know how you like it.  I
  695.            have put a lot of thought and energy into trying to create a
  696.            very easy and professional help system.  I hope I have met a
  697.            need in the programming/development department.  Let me know
  698.            what you think.  Best of all, let others know what you think
  699.            of the system.
  700.  
  701.            NOTE:  This library contains a sub set of Jason Matthews
  702.                   PROCLIP2 functions.  I very HIGHLY endorse his
  703.                   library.  I use it extensively.  If you currently use
  704.                   the library, you will probably get some link warning
  705.                   messages.  If using MS LINK, use the /NOE option to
  706.                   avoid these messages.  If using PLINK86, you will just
  707.                   have to ignore them.
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.                                       Page 11                                      Page 11                                      Page 11                                      Page 11
  724.  
  725.  
  726.  
  727.  
  728.  
  729.                           Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988                          Instant Help - INSTAHLP (c) 1988
  730.                                  Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy                                 Richard A. Murphy
  731.  
  732.  
  733.                                Registration Form for:
  734.                              Instant Help - Version 1.2
  735.  
  736.  
  737.                          Please Send To:  Richard A. Murphy
  738.                                           XEC Development, INC.
  739.                                           92B Shiawassee Ave.
  740.                                           Akron, OH  44313
  741.                                           (216) 869-6131
  742.  
  743.  
  744.                           Name:  _________________________
  745.                        Company:  _________________________
  746.                                      (If applicable)
  747.                           Addr:  _________________________
  748.                           Addr:  _________________________
  749.                           City:  _________________________
  750.                          State:  _________________________
  751.                            Zip:  _________________________
  752.  
  753.  
  754.  
  755.            Please Check One:
  756.  
  757.            __  Inclosed is my check for $25 for the registration fee.
  758.  
  759.            __  Inclosed is my check for $50 for the registration fee AND
  760.                the source code for my own use/modification.  Sorry, but
  761.                if you wish to register for rights to modify the source,
  762.                you MUST either Register with Jason Matthews for
  763.                PROCLIP2.LIB, or not use the statements from his library
  764.                (statements from his library are commented as such).  If
  765.                you don't know how to register for his library, I will
  766.                give you information on how to do it.  If you don't
  767.                already have PROCLIP2.LIB, I strongly recommend getting
  768.                it.  It is VERY useful.
  769.  
  770.                All registered persons will receive a confirmation of
  771.            their registration from me and will be informed of any
  772.            changes/updates.  If at all possible, all registered persons
  773.            will receive free updates to the Instant Help Library.
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.                                       Page 12                                      Page 12                                      Page 12                                      Page 12
  790.  
  791.  
  792.  
  793.