home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / clipper / shelp50a.arj / PRINT.ME < prev    next >
Encoding:
Text File  |  1991-08-11  |  13.0 KB  |  310 lines
  1.  
  2.  
  3.  
  4.    ┌───────────────────────────────────────────────────────────────────────┐
  5.    │  ░███  ░█  ░█ ░█████  ░██████ ░█████  ░█  ░█ ░██████ ░███    ░█████   │
  6.    │ ░█  ░█ ░█  ░█  ░█  ░█  ░█  ░█  ░█  ░█ ░█  ░█  ░█  ░█  ░█      ░█  ░█  │
  7.    │ ░█     ░█  ░█  ░█  ░█  ░█ █    ░█  ░█ ░█  ░█  ░█ █    ░█      ░█  ░█  │
  8.    │  ░███  ░█  ░█  ░████   ░███    ░████  ░█████  ░███    ░█      ░████   │
  9.    │     ░█ ░█  ░█  ░█      ░█ █    ░███   ░█  ░█  ░█ █    ░█  ░█  ░█      │
  10.    │ ░█  ░█ ░█  ░█  ░█      ░█  ░█  ░█ ░█  ░█  ░█  ░█  ░█  ░█ ░██  ░█      │
  11.    │  ░███   ░███  ░███    ░██████ ░██  ░█ ░█  ░█ ░██████ ░██████ ░███     │
  12.    │                                                                       │
  13.    │                            Version 5.0                                │
  14.    └───────────────────────────────────────────────────────────────────────┘
  15.      ─────────────────────────────────────────────────────────────────────
  16.       ───────────────────────────────────────────────────────────────────
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.                    ────────────────────────────────────────
  36.                         ──────────────────────────────
  37.  
  38.                               DJS Applications
  39.                                P.O. Box 1406
  40.                               Jesup, GA  31545
  41.  
  42.                         ──────────────────────────────
  43.                    ────────────────────────────────────────
  44.  
  45.  
  46.  
  47. SUPERHELP has added many new features which will improve the appearance
  48. and performance of your help system.   SUPERHELP now refers to versions
  49. for Clipper(Tm) Summer87 and Clipper(Tm) v5.01.  The libraries are called
  50. SUPERHELP v2.6 for Summer 87 and SUPERHELP v5.0 for Clipper(Tm) v5.01.
  51. Both libraries will retain compatibility as much as possible.  The following
  52. is a list of new features and their descriptions.
  53.  
  54.  
  55.  
  56.                            *  MULTI LEVEL HELP  *
  57.  
  58. SUPERHELP now generates code for 2 kinds of Help Systems.  First, there is
  59. 'Field Level' help, which is the same as the previous version of SUPERHELP
  60. generated.  When at a field or wait state, the F1 key will display help that
  61. is specific to that field.
  62.  
  63. Now, there is also 'Conceptual Level' help, which is general help for the
  64. procedure or group of fields.  When at a field or wait state, the F2 key will
  65. display help that is general to this screen or procedure.
  66.  
  67. When building help, SUPERHELP has another menu option which setups 'Field
  68. Level' or 'Conceptual Level' help.  You may save the option by selecting
  69. System Defaults.
  70.  
  71. There are two ways to build 'Conceptual Level' help.  If you want to build
  72. just one help screen per procedure or function then you need only to select
  73. 'Conceptual Level' from menu.  But if you need multiple help windows in
  74. procedures or functions, then PRIVATE variables named 'SHELPPROC' and
  75. 'SHELPVAR' must be declared.  Assign 'SHELPPROC' a value unique to that
  76. procedure or function.  If any higher level procedures or functions use
  77. the PRIVATE variables, then all lower level procedures or functions must
  78. also use the PRIVATE variable.  IF PRIVATE variables are used in the main
  79. module, then it must be used throughout the whole program.
  80.  
  81. When generating help, all 'Field Level' help windows will be generated to
  82. a file called Help.prg.  If there is any 'Conceptual Level' help windows,
  83. they will be generated to a file called Helpcon.prg.  The supporting
  84. functions for Help.prg and Helpcon.prg are generated to a file called
  85. Helplib.prg.  If the Help Manager option is 'On', then the Help Manager
  86. will be generated to a file called Helpmgr.prg.  All code must be compiled
  87. before being used.
  88.  
  89. When the F1 key is pressed, if 'Field Level' help is not found, the system
  90. will look for 'Conceptual Level' help.  The best way to setup a multi-level
  91. help system, is to assign the F1 key to HELP and the F2 key to HELPCON.
  92.  
  93.  
  94.                        *  REFERENCE FILE METHOD  *
  95.  
  96. The power of the SUPERHELP help system is the REFERENCE FILE.  SUPERHELP
  97. generates all window attributes and help text to the REFERENCE FILE.  The
  98. REFERENCE file has multiple advantages over other methods of storing help
  99. text.  It has security that does not allow the file to be modified after
  100. generation, it is faster than using a database file and there are less files
  101. to worry about.  Since SUPERHELP dynamically pages help text from the
  102. REFERENCE file, the speed and memory requirements can not be matched by
  103. other methods.
  104.  
  105. When generating help, make sure the option for the REFERENCE FILE is 'On'.
  106. If the option is not 'On', then the help text and attributes are generated
  107. as Clipper(Tm) Code.  Inline help code adds enormous size to your program
  108. for large applications.
  109.  
  110. With this version of SUPERHELP, generation methods of using Databases and
  111. Memoedit has been discontinued.  These methods are inferior to the
  112. REFERENCE FILE method.
  113.  
  114. The Reference file must be included with your application for the help
  115. system to work.
  116.  
  117.  
  118.  
  119.                         *  DATA DICTIONARY  *
  120.  
  121. SUPERHELP also generates a Data Dictionary listing of the project's help
  122. system.  The Data Dictionary can be generated in Full or Summary format.
  123. In full format, the listing will contain all the help window attributes
  124. as will as all the help text.  In summary format, the listing will contain
  125. only the help window attributes.
  126.  
  127.  
  128.  
  129.  
  130.                             *  USERS GUIDE  *
  131.  
  132. SUPERHELP also generates a Users Guide listing of the project's help system.
  133. The Users Guide takes all the help text that has been entered into the
  134. system and produces a title page, table of contents, and formated pages
  135. of help text.  The Users Guide can produce a manual that is ready to be
  136. distributed to your users.  By using the Order Sequence Option, the Users
  137. Guide can be put into any logical order.  Also, a system overview may be
  138. included in the Users Guide by setting up the file name at the Project
  139. Information Screen.
  140.  
  141.  
  142.  
  143.                         *  PROJECT MANAGEMENT  *
  144.  
  145. SUPERHELP is based on Project Management, which means that every help
  146. window is tied to a project when created.  Before developing any help
  147. windows, be sure to setup the Project Management information.  To allow
  148. multiple projects and programmers to develop help systems using SUPERHELP
  149. on networks or multiuser systems, the Project Management information must
  150. be set up for every project.  At the time of generation, SUPERHELP uses
  151. this information to select the help windows.
  152.  
  153.  
  154.                          *  LINK WINDOWS  *
  155.  
  156. SUPERHELP has a feature called LINK WINDOWS, which saves the developer
  157. much time on redundant help windows.  LINK WINDOWS allows the developer
  158. to create one help window and attach other help windows to it.  Help windows
  159. that share common text and attributes do not have to be duplicated throughout
  160. the help system, saving much time and program code size.
  161.  
  162. To illustrate, in a large application if there was a variable named
  163. 'Order_No' or means the same as 'Order_No' which appears 15 times throughout
  164. the application, you would create just one help window for 'Order No' and
  165. attach the 14 other windows to it.
  166.  
  167.  
  168.                           *  HELP INDEX  *
  169.  
  170. SUPERHELP creates an Help Index of all help windows created in the current
  171. project.  This Help Index allows any help windows to be called up for
  172. modification without having to return to the procedure and variable location
  173. in the program.  So what?  This feature is a time saver while jumping around
  174. from help window to help window.  You can make changes to every help window
  175. without having to trace through the application.
  176.  
  177. The Help Index even stores the current screen image at the time the help
  178. window was created.  The 'Camera On' option must be set in order to save
  179. the current screen.  This feature allows the programmer to change window
  180. attributes relative to the saved screen.
  181.  
  182.  
  183.                          *  HELP ANALYZER  *
  184.  
  185. SUPERHELP contains a utility function that analyzes the current projects
  186. help system.  This gives the programmer information about the help system
  187. being developed.  It will also make a reccomendation on the settings for
  188. generating the help.
  189.  
  190.  
  191.                          *  SPECIAL EFFECTS  *
  192.  
  193. SUPERHELP now supports 8 windowing effects (Exploding, PullDown, PopUp,
  194. Curtain, InsideOut, Pan Left, Pan Right, Normal).  All windowing effects can
  195. be Imploded.
  196.  
  197.  
  198.  
  199.                      *  END-USER MODIFIABLE HELP  *
  200.  
  201. SUPERHELP supports END-USER MODIFIABLE help.  It may be selected on a field
  202. by field basis.  The developer can decide if a help window can be modified by
  203. the end-user.  The help text can be modified by changing what is on screen or
  204. by entering addition help text.  If additional help text is going to be
  205. added, PADSIZE needs to be setup.  PADSIZE is setup as an menu item.
  206. If a help window is not going to be END-USER MODIFIABLE, then set PADSIZE to
  207. zero and select the option USER MODIFIABLE OFF.
  208.  
  209. The END-USER can change colors, move the help window, change the frame type,
  210. change the header/footer, turn On/Off Microvoice, change special effects,
  211. and lock features in the help window.  The feature of modifying help text
  212. will be in the next version.
  213.  
  214.  
  215.                      *  HELP WINDOW ORDER SEQUENCE  *
  216.  
  217. SUPERHELP supports HELP WINDOW ORDER SEQUENCE.  The help windows can be
  218. assigned a number between 0 and 9999, which is used for generating output
  219. such as Help, Data Dictionary, or Users Guide.  Before generating output,
  220. select SORT ORDER BY ORDER to use this feature.  The ORDER SEQUENCE allows
  221. the Users Guide to be arranged in a logical order.  To change the order,
  222. Select Order from the menu.  Browse through the window list until the
  223. desired window is found.  Then go to the Order Column and press Enter and
  224. add the new order number.
  225.  
  226.  
  227.                        *  INTEGRATION OF MICROVOICE  *
  228.  
  229. Microvoice(Tm) is a library which allows Clipper(Tm) to speak thru the
  230. PC's speaker.  SUPERHELP has built the links to Microvoice(Tm).  To turn
  231. Microvoice(Tm) ON, select the approiate menu option.  The first time it is
  232. run from the generated help, a window will appear to set it up.  On some
  233. computers, Microvoice does not sound clear because of the PC's internal
  234. speaker.  Please read the documentation include with Microvoice to
  235. fully understand.
  236.  
  237.  
  238.  
  239.                      *  MULTILEVEL HEADER/FOOTER DISPLAY  *
  240.  
  241. SUPERHELP supports a split level header and footer message.  This means
  242. that the header can appear either on the top line of the window or below the
  243. top line of the window.  The footer can either appear on the bottom line or
  244. above the bottom line of the window.  This feature gives the window a better
  245. appearence.
  246.  
  247.  
  248.  
  249.                        *  IMPROVED MEMORY MANAGEMENT  *
  250.  
  251. SUPERHELP internals have been rewritten.  Now SUPERHELP dynamically swaps
  252. help text from the Reference File.  Instead of needing large amounts of
  253. Freemem, it only needs enough for the window size.  This also made retrieving
  254. of help text lightening fast as while as memory effcient.  Scrolling of
  255. text is supported by PageUp and PageDown and Arrow keys.
  256.  
  257.  
  258.  
  259.                        *  SUPERHELP CONVERT PROGRAM  *
  260.  
  261. SUPERHELP includes a utility program used to convert previous version of
  262. SUPERHELP to the existing file formats.  The program will only work with
  263. versions of SUPERHELP containing 2.x.  Prior versions must be discarded.
  264. The program name is SHELPCVT.EXE.  It will be released to Registered Users
  265. Only!
  266.  
  267.  
  268.  
  269.                          * SUPERHELP FUNCTIONS *
  270.  
  271. SUPERHELP includes 3 functions for designing the help system.  The functions
  272. vary in the way each is used.  Superbuild allows the building and generating
  273. of help systems.  Minibuild allows only the building of help systems.
  274. Codebuild allows only the generating of help system.  Normally, Superbuild
  275. will be used to build and generate the help systems, but under conditions
  276. where memory is a problem then Minibuild and Codebuild should be used.
  277. All of SUPERHELP Library can be dynamically overlaid with the dynamic overlay
  278. linkers on the market.  If memory problems still occur after running
  279. Codebuild,  then write a simple program which contains only a call to
  280. Codebuild.
  281.  
  282. All 3 functions must be declared external in the program before being called.
  283.  
  284.  
  285.  
  286.                        *  SUPERHELP RECOVERY SYSTEM  *
  287.  
  288. Under development is a new Utility which allows lost help systems to be
  289. recovered.  The utility processes the Reference file created with SUPERHELP.
  290. All help can be recovered except the LINKED list file.  It will be released
  291. to Registered Users Only!
  292.  
  293.  
  294.                             *  NEW MANUAL  *
  295.  
  296. SUPERHELP will feature a new manual which will be much improved over the
  297. previous manual.  At this time no manual will be sent out.  Some sort of
  298. documentation will be included with the release of SUPERHELP v5.0.
  299. Thank You for being patient and for your support!
  300.  
  301.  
  302.                           *  DEMO PROGRAMS  *
  303.  
  304. SUPERHELP contains a demo on the disk.  Before building your help system,
  305. run the demo program to get a fill of all the features of SUPERHELP.
  306.  
  307.  
  308.  
  309.  
  310.