home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR36 / HLPSYS11.ZIP / HELPSYS.TXT < prev    next >
Text File  |  1993-08-26  |  5KB  |  124 lines
  1. HELPSYS 1.1
  2.  
  3. HelpSys Function Library
  4.  
  5.     This product is being released as a Shareware product.  This means that this
  6. version of the program may be freely copied and evaluated by anyone.  If you
  7. decide that this product will suite your needs, simply send a $20.00 donation
  8. to us and we will send you a more powerful version of the software that let's
  9. you have more control.  Also included will be several functions that allow
  10. window manipulation, printing and video stack saving.  These will be documented
  11. and include sample programs on usage.
  12.  
  13.     This HelpSys module was designed for quick and easy help screens with-out
  14. adding a single line of code to you Clipper 5.01 or Clipper 5.2 application.
  15.  Simply link in the object file, include the HELPSYS.LIB file and create your
  16. help text file.  That's all there is to it.  Your executable code size is
  17. slightly increased and you'll have field level help with out much work on your
  18. part.
  19.  
  20.     The shareware version does NOT contain any of the help control modules or 
  21. window printing modules.  This version is also slightly crippled, when pressing
  22. F1 to invoke the help screen(s), you can only bring up the help screens a total
  23. of 10 times per application execution.  This should be more than sufficient for
  24. your testing.  Also, upon registering, for an additional $10.00 I will send
  25. you full source code that you can modify as needed.  I know that when
  26. developing, I always feel more comfortable about my application when using 
  27. libraries that I have control over.  You will not be allowed to distribute the
  28. source code or object code for the registered version of this software.
  29.  
  30. Features:
  31.     Press F1 for help from ANY screen and field
  32.     On-Line help without ANY additional programming
  33.     Field Level Help with a professional look
  34.     Procedural level help for non-field entries
  35.     Capable of Several Screens of help per field, not just one line
  36.     Minimal code size increase
  37.     Intelligent help window moving when help window covers the current field
  38.     You can use any text editor to create the help file(s)
  39.  
  40. Additional Features after registering:
  41.     Window and Text Color Control
  42.     Window Positioning Control
  43.     Support for Multiple Help Files
  44.     Enable/Disable the memory save feature
  45.     Generic Window functions that can be used in your own programs
  46.     (including printing within a window)
  47.     Video Stack function calls
  48.     Quick Alert Printing function
  49.     DOCUMENTATION
  50.     [Optional Source Code written entirely in Clipper]
  51.  
  52. Why should I register?
  53.  
  54.     I feel that after all this work and effort, $20.00 is a minimal charge for providing 
  55. such capabilities.  There are several other routines that I've written over the past several 
  56. years that I'll plan on releasing as Shareware (including software security routines).  This is 
  57. to everyones advantage.
  58.  
  59. Jeff Lewis
  60. P.O. Box 441456
  61. Indianapolis, Indiana  46244
  62.  
  63. CIS: 70711,3030                      INTERNET: JLEWIS@INDYCMS.IUPUI.EDU
  64.  
  65.  
  66. Program Notes:
  67.  
  68.     When Linking include HELPSYS.OBJ with your program and include 
  69. HELPSYS.LIB
  70.  
  71. RTLINK FILE TEST.OBJ,HELPSYS.OBJ LIB HELPSYS
  72. or
  73. BLINKER FI TEST.OBJ HELPSYS.OBJ LIB HELPSYS
  74.  
  75. Create your help file (HELP.TXT is the default) in the executables current
  76. directory using the following syntax:
  77.  
  78. ~FIELDNAME
  79. xxxxxxxxxxxxxxxxxxxxxxxxxx
  80. xxxxxxxxxxxxxxxxxxxxxxxxxx
  81. .
  82. .
  83. ~FIELDNAME
  84. yyyyyyyyyyyyyyyyyyy
  85. yyyyyyyyyyyyyyyyyyy
  86. .
  87. .
  88.  
  89.     The xxxx.... and yyyy.... lines indicate the help text for the fieldname.
  90.  The fieldname MUST be all capital letters and must be preceded with a '~'
  91. character.  The help text can be as many lines as needed and there is no real
  92. limit on the number of fields that can be contained in the help file.  The only
  93. limitation is that a single help file can not exceed 64K in size.  The
  94. registered version allows multiple help files to be used in a single
  95. application, this will help with the 64K limitation.
  96.  
  97.     Procedure level help is also available by using the ~@PROCNAME instead of
  98. just the '~' character.  The PROCNAME field must also be capitalized.
  99.  
  100. ~@PROCNAME
  101. zzzzzzzzzzzzzzzzzzzzzzzzzzz
  102.  
  103.     Placing an & in column 1 represents a comment
  104.  
  105. EXAMPLE file Help.Txt
  106.  
  107. & This is an example help file
  108. & I could have several fields and procedure level help in the same file
  109. ~LASTNAME
  110.  
  111. Enter the customers last name.
  112.  
  113. This will be permanently stored in the database for future retrieval.
  114. ~FIRSTNAME
  115.  
  116. Enter the customers first name.
  117.  
  118. ~@BrowCust
  119.  
  120. This is a customer data list screen.  Use the cursor keys to scroll up, down,
  121. left and right.
  122.  
  123. ~END
  124.