home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / quikhelp.zip / QUIKHELP.HLP next >
Text File  |  1988-10-03  |  41KB  |  990 lines
  1. %white,blue
  2. ╒═══════════════════════════════════════════════════════════════════════════╕
  3. │                    QuikHelp Beta - Version 1.0                            │
  4. │                         *** by DataBex ***                                │
  5. │                                                                           │
  6. │  Now Available - Version 1.1 ! (Started Shipping September 15, 1988)      │
  7. │                                                                           │
  8. │  o  450% FASTER Topical Indexing.                                         │
  9. │  o  Updates to *ALL* Registered Users of Beta 1.0                         │
  10. │  o  Registration is *FREE*                                                │
  11. │  o  To Register: Send Name and Address to:                                │
  12. │                              DataBex                                      │
  13. │                   "QuikHelp - Beta Registration"                          │
  14. │                      6065 Mission Gorge Road                              │
  15. │                             Suite #414                                    │
  16. │                        San Diego, CA 92120                                │
  17. │  o  Or E-mail Name and Address on:                                        │
  18. │                    -  MCI mail   - 650-318-9786                           │
  19. │                    -  CompuServe - 72271,2152                             │
  20. │                    -  The Source - AAN838                                 │
  21. ╘═══════════════════════════════════════════════════════════════════════════╛
  22.                        QuikHelp Testing Program
  23.                     Version 1.00 - Beta Shareware
  24. @Main Menu 1
  25. %aqua,magenta
  26. * Program Name: quikhelp.hlp *
  27. * (c) 1988 by DataBex *
  28. **************************************************************************
  29. * Created: 6/16/1988 at 11:29                                            *
  30. * main = Version 1.00 - Shareware Distribution  .OBJ Module only.        *
  31. * Revision:  Last Revised: 6/16/1988 at 11:55                            *
  32. * Called From:                                                           *
  33. *************************** ALL RIGHTS RESERVED **************************
  34.   ╒═════════ Main Menu 1 ════════╕     
  35.   │                              │     
  36.   │                              │     
  37. > │ [ Main Menu 2              ] │     
  38. > │   QuikHelp Features          │       ╒═════════════════════╕
  39. > │   Introduction to QuikHelp   │       │ * Q U I K H E L P * │
  40. > │   QuikHelp specifications    │       ├─────────────────────┤
  41. > │   Keyboard controls          │       │   Copyright 1988    │
  42. > │   Menus                      │       │        by           │
  43. > │   QuikHelp Screens           │       │      DataBex        │
  44. > │   QuikHelp Formatting Hooks  │       │ All Rights Reserved │
  45. > │   New Topic Hook             │       ╘═════════════════════╛   
  46. > │   Screen Feed Hook           │         6065 Mission Gorge Road
  47. > │   Menu Line Hook             │         Suite #414 
  48. > │   Menu Delimiters            │         San Diego, CA 92120
  49. > │   Comment Hook               │ 
  50. > │   Color Selection Hook       │ Royalty-free On-line Reference System
  51.   │                              │ for Clipper Applications Developers. 
  52.   │                              │     
  53.   ╘══════════════════════════════╛ 
  54. @Main Menu 2
  55. %red,white
  56.  
  57.   ╒═════════ Main Menu 2 ════════╕                                      
  58.   │                              │  ╔════════════════════════════════╗  
  59. > │ [Main Menu 1              ]  │  ║                                ║  
  60. > │  QuikHelp BOF Behavior       │  ║                                ║  
  61. > │  Interfacing with Clipper    │  ║       Q U I K H E L P          ║  
  62. > │  Calling from DOS            │  ║                                ║  
  63. > │  Debugging                   │  ║  QuikHelp can be incorporated  ║  
  64. > │  Editors                     │  ║  in your Clipper programs.     ║  
  65. > │  Help File Structure         │  ║     ** Royalty FREE **         ║  
  66. > │  QHindex                     │  ║                                ║  
  67. > │  QuikHelp Screen Structure   │  ║                                ║  
  68. > │  Search Topic                │  ║  *NEWS FLASH/NEWS FLASH/NEWS FL║  
  69. > │  Example of Use              │  ║  QuikHelp - Version 1.1        ║  
  70. > │  Error Messages              │  ║  Started Shipping 09/15/88     ║  
  71. > │  Versions 1.5/2.0 !!         │  ║  - 450% FASTER topical indexing║  
  72. > │  Release 2.0                 │  ║  - Updates available to ALL    ║  
  73. > │  The Wish List               │  ║    *Registered* users of Beta  ║  
  74. > │  Free Support Policy         │  ║    version 1.0.                ║  
  75.   ╘══════════════════════════════╛  ║  - *FREE* Registration         ║  
  76.                                     ╚════════════════════════════════╝
  77. @QuikHelp Features
  78. %black,aqua
  79.  
  80.  
  81.  
  82.    ╔═════════════════════════════════════════════╦═════════════════════╗
  83.    ║  QuikHelp Features                          ║  Limits             ║
  84.    ╠═════════════════════════════════════════════╬═════════════════════╣
  85.    ║  maximum key length                         ║  127                ║
  86.    ║  maximum topics per help file               ║  1000               ║
  87.    ║  maximum number of screens per help file    ║  unlimited          ║
  88.    ║  maximum number of menus per help file      ║  unlimited          ║
  89.    ║  maximum number of colors used              ║  unlimited          ║
  90.    ║  maximum help file size                     ║  unlimited          ║
  91.    ║  maximum menu selections per screen         ║  22                 ║
  92.    ║  storage type                               ║  ASCII text file    ║
  93.    ╚═════════════════════════════════════════════╩═════════════════════╝
  94.  
  95.  
  96.  
  97.     ┌─────────────────┐
  98. >   │  [Main Menu 1]  │
  99. >   │   Main Menu 2   │
  100.     └─────────────────┘
  101. @Introduction to QuikHelp
  102. %white,black
  103.  
  104.  Quikhelp has been designed for the Clipper Developer.  The design stems from
  105.  the need to put full-system documentation on-line in an appealing and
  106.  professional fashion, AND at the same time do so with a minimum amount of
  107.  intervention from the Developer.
  108.  
  109.  Consequently, Quikhelp provides an easy-to-use set of "hooks" which allow
  110.  the Developer to accomplish just that.  The control of text, format, menus,
  111.  and color are all done through these "hooks".  All of these can be
  112.  controlled with the developer's text editor.
  113.  
  114.  Quikhelp can be used on virtually any text file with a maximum character
  115. per line count of 78, (more than adequate for most professionally produced
  116. documentation.
  117.  
  118.         
  119.  
  120.     ┌─────────────────┐
  121. >   │  [Main Menu 1]  │
  122. >   │   Main Menu 2   │
  123.     └─────────────────┘
  124. @QuikHelp specifications
  125.                               QuikHelp
  126.    ╔═════════════════════════════════════════════════════════════════════╗
  127.    ║                                                                     ║
  128.    ║  Full-system documentation, On-line instantly                       ║
  129.    ║  Topical reference search capability                                ║
  130.    ║  Context-sensitive help                                             ║
  131.    ║  Expandable, what-you-see-is-what-you-get style                     ║
  132.    ║  ASCII file storage for all text & menus                            ║
  133.    ║  Maximum lines per screen: 22                                       ║
  134.    ║  Unlimited amount of menus                                          ║
  135.    ║  Unlimited screens                                                  ║
  136.    ║  Screens & Menus user-defined as part of the text                   ║
  137.    ║  User definable help screens & menus                                ║
  138.    ║  Dos, Dbase, Clipper, & FoxBase compatible                          ║
  139.    ║  No recompiling after textual changes                               ║
  140.    ║  No knowledge of dBASE or other programming language required       ║
  141.    ║  Softcoding techniques through "hooks"                              ║
  142.    ║                                                                     ║
  143.    ╚═════════════════════════════════════════════════════════════════════╝
  144. @Keyboard controls
  145. %blue,white
  146.  
  147.  ┌───────────────┬──────────────────────────┐
  148.  │  Key          │   Action                 │
  149.  ├───────────────┼──────────────────────────┤
  150.  │               │                          │             ┌─────────────────┐
  151. >│  ESC..........│   exit QuikHelp          │             │  [Main Menu 1]  │
  152. >│               │                          │             │   Main Menu 2   │
  153.  │  ARROW KEYS...│   menu bar control       │             └─────────────────┘
  154.  │               │                          │
  155.  │  PgUp.........│   previous page          │
  156.  │  PgDn.........│   next page              │
  157.  │               │                          │
  158.  │  ENTER........│   make a selection       │
  159.  └───────────────┴──────────────────────────┘
  160.  
  161. ^
  162.  
  163.  NOTE:
  164.  
  165.  If you see the "press a key to continue ..." message, pressing any
  166.  key will show the next help screen.  Pressing the "PgDn" key produces the
  167.  same effect.
  168.  
  169.  
  170. @Menus
  171. %white,blue
  172.  
  173.  Quikhelp menus are defined as an integral part of any screen.  Menus allow
  174.  the user to select the topic desired.  The ">" hook (placed on the first
  175.  COLUMN of text) designates a menu item.  The actual menu selection of text
  176.  can be delimited with "[ ]" hooks.  These delimited hooks control the width
  177.  of the menu item to be selected.  Each screen may contain ONE MENU of with a
  178.  maximum of 22 menu items.
  179.  
  180.  
  181.  
  182.                       ┌──────── This is an example of QuikHelp menu
  183.                       │
  184.                       
  185.                       ┌─────────────────┐
  186. >                     │  [Main Menu 1]  │
  187. >                     │   Main Menu 2   │
  188.                       └─────────────────┘
  189. ^
  190.  
  191.  Each menu item should be a topical reference as Quikhelp will attempt to
  192.  locate that topic when that menu item is selected.
  193.  
  194.  Notice how the "[ ]" hook delimiters are only placed on the first line of
  195.  the menu.  The width of these hooks defines the width of the widest menu
  196.  item.
  197.  
  198.  
  199.   eg:
  200.  
  201.     ╔═════════════════════════════════════════════════════════════════╗
  202.     ║                      Employee Maintenance                       ║
  203.     ║                                                                 ║
  204.     ║        Please select a help topic from the selection below:     ║
  205.     ║                                                                 ║
  206. >   ║>                         [[Input        ]]                      ║
  207. >   ║>                           Review/Update                        ║
  208. >   ║                            Deletion                             ║
  209. >   ║                            Utility                              ║
  210.     ╚═════════════════════════════════════════════════════════════════╝
  211. ^
  212.  
  213.  If the second menu item is selected ("Review/Update"), Quikhelp will search
  214.  through the help file for a topical reference indicated in the help file by
  215.  "@Review/Update".  If the reference if found, the section is displayed;
  216.  otherwise, "No Match" is indicated and the help file is left at its current
  217.  position.          
  218.  
  219.              ┌──────────────────────────────────┐
  220.              │ Usage :   >     [ help topic ]   │
  221.              └──────────────────────────────────┘
  222.  
  223.  
  224. @QuikHelp Screens
  225. %yellow,blue
  226.  
  227.  Since Quikhelp is a screen-oriented help/reference display facility, all
  228.  screens receive equal treatment.  This means that menus and help text
  229.  screens can be reviewed one at a time or referenced via a menu selection.
  230.  
  231.  Menus can be quickly created and maintained since they are just another
  232.  part of the overall reference text.  While menus are not required, their
  233.  inclusion provides a simple and reliable interface with the end user,
  234.  providing the end user with the option of viewing only the information he
  235.  selects.
  236.  
  237.  
  238.     ┌─────────────────┐
  239. >   │  [Main Menu 1]  │
  240. >   │   Main Menu 2   │
  241.     └─────────────────┘
  242. @QuikHelp Formatting Codes 
  243. %red,aqua
  244.  
  245.  Quikhelp provides you, the Developer, with six formatting codes or "hooks"
  246.  to help control the presentation of the help/reference being displayed. 
  247.  
  248.  ALL "HOOKS" MUST BE PLACED ON COLUMN 0.
  249.  
  250.  EACH "HOOK" MUST BE ON ITS OWN LINE.
  251.  
  252.         ┌─────────┬────────────────────────────────┐
  253.         │  HOOK   │    DEFINITION/ACTION           │
  254.         ├─────────┼────────────────────────────────┤
  255.         │         │                                │
  256.         │    @    │    New selection topic         │
  257.         │    %    │    color selection             │
  258.         │    *    │    comment out line            │
  259.         │    >    │    menu line                   │
  260.         │    []   │    menu delimiters             │
  261.         │    ^    │    new screen ( screen feed )  │
  262.         └─────────┴────────────────────────────────┘
  263. @New Topic Hook  
  264. %magenta,black
  265.  
  266.                          New Topic Hook "@"
  267.                          ══════════════════ 
  268.  
  269.  The "@" symbol is the code used to indicate a new topic.  The index
  270.  facility supplied with Quikhelp uses this code as a reference to build and
  271.  maintain the index file which allows for topical reference selection.
  272.  
  273.  The "@" symbol also indicates the beginning of a new screen page.
  274.  
  275.  
  276.   ┌──────────────────────────────┐
  277.   │  Usage :   @<topical search> │
  278.   └──────────────────────────────┘
  279.  
  280.       Example:  @Employee Data
  281.  
  282.  
  283.     ┌─────────────────┐
  284. >   │  [Main Menu 1]  │
  285. >   │   Main Menu 2   │
  286.     └─────────────────┘
  287. @Screen Feed Hook
  288. %blue,white
  289.  
  290.                            Screen Feed Hook "^"
  291.                            ════════════════════
  292.  
  293.  Uses:
  294.         1. Indicates the beginning of a new screen.
  295.         2. Similar to a Form Feed on a printer.
  296.         3. Allows for user-defined page breaks.
  297.  
  298.   ┌──────────────────────────────┐
  299.   │  Usage:  ^                   │
  300.   └──────────────────────────────┘
  301.  
  302. @Menu Line Prompt
  303. %white,red
  304.  
  305.                            Menu Line Prompt ">"
  306.                            ════════════════════
  307.  Information:
  308.         1. Indicates a Menu Item.
  309.         2. Continuous, columnar format.
  310.         3. Intermixed with other text on same line
  311.  
  312.   ┌──────────────────────────────┐
  313.   │  Usage :   ^                 │
  314.   └──────────────────────────────┘
  315.  
  316.         Here's an example of a menu using bad syntax:
  317.  
  318.     ╔══════════════════════════╗
  319.     ║>   [First Choice   ]     ║
  320.     ║                          ║ ───────  Menu items must be continous.
  321.     ║>    Second Choice        ║           No empty line between choices.
  322.     ║>    Third Choice         ║
  323.     ║>    Fourth Choice        ║
  324.     ╚══════════════════════════╝
  325. ^
  326.         Now, here's an example of a menu with proper syntax:
  327.  
  328.     ╔══════════════════════════╗
  329. >   ║>  [[First Option   ]]    ║ ───────  Menu delimiters need only be   
  330. >   ║>    Second Option        ║           placed on the first line.
  331. >   ║>    Third Option         ║
  332. >   ║>    Fourch Option        ║
  333.     ║                          ║
  334.     ╚══════════════════════════╝
  335.  
  336.  
  337.  
  338. @Menu Delimiters
  339. %black,aqua
  340.  
  341.                             Menu delimiters
  342.                             ═══════════════  
  343.  
  344.  Quikhelp uses the menu delimiters to highlight in reverse video the
  345.  possible options in the menu available for selection.  As mentioned above,
  346.  these menu delimiters must be used only on the first menu selection. 
  347.  Quikhelp takes care of the rest automatically.
  348.  
  349.     Example:
  350.     ╔═══════════════════════╗               Delimiters must always
  351. >   ║>  [[Add/Update     ]] ║───────────── be placed on the FIRST menu
  352. >   ║>    Review Only       ║               item.
  353. >   ║>    Delete            ║
  354. >   ║>    Utilities         ║
  355.     ╚═══════════════════════╝
  356. ^
  357.     ╔═══════════════════╗
  358.     ║>    Phase One     ║
  359.     ║>   [Phase Two  ]  ║───────────── This won't work.
  360.     ║>    Phase Three   ║
  361.     ║>    Phase Four    ║
  362.     ╚═══════════════════╝
  363.  The menu item delimited is the topical reference when this item is
  364.  selected. 
  365.  
  366.  Therefore, is stands to reason that for the menu above, there must be valid
  367.  points of reference in the help file indicated with the "@" symbol.
  368.  
  369.         Example:
  370.                 @Phase One
  371.                 @Phase Two
  372.                 @Phase Three
  373.                 @Phase Four
  374.  
  375.  If the resulting topical reference is not found, the "No Match" message
  376.  will appear briefly at the bottom right-hand corner of the screen, and the
  377.  first help screen is displayed instead.
  378.  
  379. @Comment Hook
  380. %blue,white
  381.                               Comment Hook "*"
  382.                               ════════════════
  383.  
  384.  As a developer, you are already familiar with the dBASE comment character,
  385.  our friend, the asterisk "*".  You can include lines in your documentation
  386.  which will no be displayed by Quikhelp.  
  387.  
  388.  ALL HOOKS MUST BE PLACED IN COLUMN 0.
  389.  
  390.         Here's an example:
  391.   ╔══════════════════════════╗
  392.   ║   >   [selection one  ]  ║
  393.   ║   *>    selection two    ║ ───────── Comment out this line in the
  394.   ║   >    selection three   ║            help file.
  395.   ║   >    selection four    ║
  396.   ╚══════════════════════════╝
  397.                                   ╔══════════════════════════╗
  398. >                                 ║   >   [selection one  ]  ║
  399. > This is what  ───────────────  ║   >    selection three   ║
  400. > you see.                        ║   >    selection four    ║
  401.                                   ╚══════════════════════════╝
  402. @Color Selection Hook
  403. %aqua,magenta
  404.                                Color Hook "%"
  405.                                ══════════════
  406.  
  407.  ALL HOOKS MUST BE PLACED IN COLUMN 0.
  408.  
  409.  Quikhelp allows the developer to select the color for all text displayed.
  410.  By indicating the color desired all displayed text will be output in that
  411.  color until the next color "hook" is given. 
  412.  
  413.  Quikhelp allows you to change the colors as often as you like.
  414.  
  415.  Screen color can be changed by placing the "%" color hook at the beginning
  416.  of a new topic or new page. An example illustrates:
  417.  
  418.         Example: New Topic                 Example: New Page
  419.  
  420.                  @Topic One                          ^
  421.                  %white,blue                         %yellow,black
  422.     ┌─────────────────┐
  423. >   │  [Main Menu 1]  │
  424. >   │   Main Menu 2   │
  425.     └─────────────────┘
  426. ^
  427.  
  428.  
  429.   ┌─────────────────────────────────────────────────┐
  430.   │  Usage:   %foreground color, background color   │
  431.   └─────────────────────────────────────────────────┘
  432. ^
  433.  
  434.   The valid colors are:
  435.  
  436.    ╒═════════╕
  437. %white,black
  438.    │ black   │                                                                .
  439. %black,white
  440.    │ white   │                                                                .
  441. %black,red
  442.    │ red     │                                                                .
  443. %black,blue
  444.    │ blue    │                                                                .
  445. %black,green
  446.    │ green   │                                                                .
  447. %black,yellow
  448.    │ yellow  │                                                                .
  449. %black,magenta
  450.    │ magenta │                                                                .
  451. %black,aqua
  452.    │ aqua    │                                                                .
  453.    ╘═════════╛
  454. %blue,aqua
  455.  Example:     %blue,aqua                                                           .
  456. %aqua,magenta
  457.  
  458.  Default color selection is white in the event of improper spelling
  459.  or color selection.
  460.  
  461.  Example:   %blue,magNeta ;this will result in a blue foreground and a white
  462.                        background
  463.  
  464. @QuikHelp BOF Behavior
  465. %white,blue
  466.                       BOF - Beginning of File Behavior
  467.  
  468.  Here's a typical help/reference layout:
  469.  
  470.             Physical BOF
  471.                    ╒═════════════════════╕
  472.                    │@TOPIC A             │
  473.                    │                     │
  474.                    │  screen 1           │
  475.                    │                     │
  476.                    │@TOPIC B             │
  477.                    │                     │
  478.                    │  screen 2           │
  479.                    │                     │
  480.                    │@TOPIC C             │
  481.                    │                     │
  482.                    │  etc.               │
  483.                    │                     │
  484.                    ╘═════════════════════╛
  485.             Physical EOF - (End of File)
  486. ^
  487.  
  488.                            Physical & Logical BOF
  489.                            ══════════════════════
  490.  Physical BOF is the actual beginning of the file.
  491.  
  492.  Logical BOF is the first screen of a selected menu item. This can vary from
  493.  selection to selection. Logical BOF prevents the user from scrolling to
  494.  screens prior to the one selected. 
  495.  
  496.  
  497.  
  498.     ┌─────────────────┐
  499. >   │  [Main Menu 1]  │
  500. >   │   Main Menu 2   │
  501.     └─────────────────┘
  502. @Interfacing with Clipper
  503. %white,magenta
  504.  
  505.  QuikHelp is written entirely in Clipper - Summer '87 version.
  506.  
  507.  In order for your program to gain access to QuikHelp directly, 
  508.  all you have to do is link the QuikHelp.lib library at link time.
  509.  
  510.  
  511.     ┌─────────────────┐
  512. >   │  [Main Menu 1]  │
  513. >   │   Main Menu 2   │
  514.     └─────────────────┘
  515. ^
  516.                            Context-sensitive Help
  517.                            ══════════════════════
  518.  
  519.  To go directly to a specified topical reference simply use the following
  520.  syntax:
  521.  
  522.       ╒════════════════════════════════════════════════╕
  523.       │   Usage:  qh( [helpfile.hlp], [search topic] ) │
  524.       ╘════════════════════════════════════════════════╛
  525.      
  526.  Quikhelp will open the specified help file and display the first screen
  527.  found by the topic requested.  (Now we are at the Logical BOF.)
  528.  
  529.  
  530.  
  531.                  Example: qh( "databex.hlp", "Operations" )
  532. ^
  533.  
  534.                               General Reference
  535.                               ═════════════════
  536.  
  537.                       ╒═══════════════════════════════╕
  538.                       │   Usage:    qh([helpfile.ext])│
  539.                       ╘═══════════════════════════════╛
  540.  
  541.  Calling Quikhelp in this fashion will simply open the helpfile specified
  542.  and display the opening screen for this file.  (The opening screen of a help
  543.  file is typically, though not necessarily a MENU of options.)
  544.  
  545.  
  546.                         Example: qh( "databex.hlp" )
  547. ^
  548.  
  549.                               Default Reference
  550.                               ═════════════════
  551.  
  552.                           ╒══════════════════════╕
  553.                           │   syntax:   qh( )    │
  554.                           ╘══════════════════════╛
  555.  
  556.  Calling Quikhelp in this fashion will cause the file "quikhelp.hlp" to be
  557.  searched for and, if found, opened and turned to the first page of the file.
  558.         
  559.                                 Example: qh()
  560. @Interfacing with Dbase
  561. %blue,white
  562.                               Quikhelp & dBASE
  563.                               ════════════════
  564.  Quikhelp is optimally designed to work best with Clipper Summer '87
  565.  version. However, you may write a short program, including the necessary
  566.  Quikhelp functions and parameters, compile it with Clipper and Run/! this
  567.  from inside of any other package database or otherwise that is capable of
  568.  running a DOS shell from within that package.
  569.        
  570.                 ╒══════════════════════════════════════════╕
  571.                 │  Usage:  run [yourprog]                  │
  572.                 │     or:  ! [yourprog]                    │
  573.                 ╘══════════════════════════════════════════╛
  574.  
  575.  This is obviously a quick and simple solution that will work given enough
  576.  available memory to load and run "yourprog".
  577.  
  578.  Quikhelp has been designed specifically to work in conjunction with
  579.  Clipper.  Working with any other program is simply an added bonus.
  580.     ┌─────────────────┐
  581. >   │  [Main Menu 1]  │
  582. >   │   Main Menu 2   │
  583.     └─────────────────┘
  584. @Calling From Dos
  585. %yellow,black
  586.  
  587.                                Quikhelp & DOS
  588.                                ══════════════
  589.  Quikhelp can be operated from DOS by again writing a small program in
  590.  Clipper including any necessary references to help files and topics, and by
  591.  simply running the resulting Clipper/Quikhelp  .EXE file directly from DOS.
  592.  
  593.  (Unofficial Note:)
  594.  We might suggest making a generic enough Clipper program utilizing the
  595.  Quikhelp library to allow testing of all documentation while in the actual
  596.  editing/integrating phase.  How?  Hint: try a macro or two.
  597.  
  598.  A virtual endless array of uses are available.  However, remember, Quikhelp
  599.  has been designed to work with Clipper.  Any other uses are simply added
  600.  bonuses.
  601.  
  602.     ┌─────────────────┐
  603. >   │  [Main Menu 1]  │
  604. >   │   Main Menu 2   │
  605.     └─────────────────┘
  606. @Debugging
  607. %green,red
  608.  
  609.                                Instant Replay 
  610.                                ══════════════
  611.  
  612.  While incorporating existing documentation into a newly developed Quikhelp
  613.  reference file of your choice, all of the textual edits are available
  614.  immediately when viewing the help file under Quikhelp.
  615.  
  616.  In order to see the color, layout or other elements of your documentation
  617.  try using a simple generic version of a Clipper/Quikhelp program. See
  618.  "Unofficial Note:" under  Quikhelp & DOS section above.
  619.  
  620.  Since the exact byte offset of the topical references are critical for
  621.  proper menu item searching, be sure to delete the corresponding ".QHX" file
  622.  so that Quikhelp can automatically generate a new, up-to-date index file.
  623.  
  624.     ┌─────────────────┐
  625. >   │  [Main Menu 1]  │
  626. >   │   Main Menu 2   │
  627.     └─────────────────┘
  628. @Editors
  629. %black,white
  630.  
  631.                               ASCII Help Files
  632.                               ════════════════
  633.  Quikhelp operates only with pure ASCII text files, both for the help file
  634.  which you provide and for the index file Quikhelp generates automatically.
  635.  Any text editor, used in pure ASCII TEXT mode, will suffice. 
  636.  
  637.  Since the help files are ASCII, this provides you the distinct advantage of
  638.  updating the documentation from time to time or even allowing the end user
  639.  to maintain/update any help information.
  640.  
  641.  Also as an added convenience, if the text editor or word processor supports
  642.  a page size facility, by setting the page size to 22 lines per page, you
  643.  will be able to produce exact frames of the text Quikhelp will display.  Of
  644.  course, in Quikhelp you will have menus, colors, borders, and a display line
  645.  to enhance the overall picture.  But the text will look the same.
  646.     ┌─────────────────┐
  647. >   │  [Main Menu 1]  │
  648. >   │   Main Menu 2   │
  649.     └─────────────────┘
  650. ^
  651.  Quikhelp can display the full range of IBM ASCII characters.
  652.  Simply include them in the help file, Quikhelp takes care of the rest.
  653.  
  654.                 Example:   ▒░▓ ■ ∞ ε ± ÷ √ ⌡ ⁿ Æ ½ ¿ φ ≤≥ Ω
  655.                                      or
  656.                             Example:        
  657.  
  658. @Help File Structure
  659. %white,black
  660.  
  661.  Quikhelp provides you with the freedom to tailor your help file to meet the
  662.  specific application.
  663.  
  664.  The following guidelines are simply suggestions on how you may quickly
  665.  obtain the most professional results with Quikhelp.  
  666. ^          
  667.            ╒═════════════════════╕ Physical BOF
  668.            │@Main Menu           │
  669.            │    Topic Option 1   │
  670.            │    Topic Option 2   │
  671.            │    Etc.             │
  672.            │@Topic 1             │                   ╒═════════════════╕
  673. >          │    Screen 1         │                   │  [Main Menu 1]  │
  674. >          │    Screen 2         │                   │   Main Menu 2   │
  675.            │    Screen 3         │                   ╘═════════════════╛   
  676.            │@Topic 2             │                      
  677.            │    Screen 1         │
  678.            │    Screen 2         │
  679.            │    Screen 3         │
  680.            │@Topic 3             │
  681.            │    Screen 1         │
  682.            │    Screen 2         │
  683.            │    Screen 3         │
  684.            │    Etc.             │
  685.            │                     │
  686.            │   Menu Option 1     │
  687.            │   Menu Option 2     │
  688.            ╘═════════════════════╛ Physical EOF
  689. ^
  690.                              The Suggested Ideal
  691.                              ═══════════════════
  692.  
  693.  Typically the first should screen should contain a front-end menuing system
  694.  for the entire help file currently loaded.  Since there is no limit to the
  695.  number of screens or menus in a help file, theoretically the first menu
  696.  could present a choice of 22 menu items.  These menu items could in turn be
  697.  nothing more than other menus with additional choices of up to 22 choices as
  698.  well.  These additional 22 choices could in turn be menu items, etc.  The
  699.  possibilities are virtually endless.  There is certainly no inherent limit
  700.  to the number of "nested menus" or "choices" that can be created.  There
  701.  probably is a practical limit which will be determined by the
  702.  help/reference file itself.
  703.  
  704.  A few words of caution:
  705.  The last screen at the Physical EOF should have a menu reference to
  706.  somewhere, preferably the opening screen.
  707.     ┌─────────────────┐
  708. >   │  [Main Menu 1]  │
  709. >   │   Main Menu 2   │
  710.     └─────────────────┘
  711. @QHindex
  712. %blue,aqua
  713.  
  714.                               Quikhelp Indexing
  715.                               ═════════════════
  716.  Quikhelp provides automatic indexing of topics within a help file whenever
  717.  a related ".QHX" file is not present.  INDEXING IS AUTOMATIC.
  718.  
  719.  However, the function QHINDEX() is provided in the Quikhelp Library and
  720.  can be called as follows:
  721.                       ╒══════════════════════════════╕
  722.                       │  Usage: QHindex(helpfile.ext)│
  723.                       ╘══════════════════════════════╛
  724.  
  725.  This function will build an index file with the same name of the help file
  726.  and add the extension of ".QHX".  The ".QHX" is automatic, mandatory and
  727.  cannot be overridden.
  728.     ┌─────────────────┐
  729. >   │  [Main Menu 1]  │
  730. >   │   Main Menu 2   │
  731.     └─────────────────┘
  732. @QuikHelp Screen Structure
  733. %aqua,black
  734.  
  735.  Line 0  ╒═══════════════════════════════════════════════════════════════╕
  736.          │                                                               │
  737.  line 2  │ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| │
  738.          │                                                               │
  739.          │                                                               │
  740.          │                                                               │
  741.          │           Maximum of 22 lines of text displayed here.         │
  742.          │                                                               │
  743.          │                                                               │
  744.          │                                                               │
  745.          │                                                               │
  746.          │                                                               │
  747.          │                                                               │
  748.          │                                                               │
  749.          ╘═══════════════════════════════════════════════════════════════╛
  750.  line 24  ------------------ Quikhelp Display line ----------------------
  751.  
  752.     ┌─────────────────┐
  753. >   │  [Main Menu 1]  │
  754. >   │   Main Menu 2   │
  755.     └─────────────────┘
  756. ^
  757.                         Quikhelp Supplied Formatting
  758.                         ════════════════════════════
  759.  Each Quikhelp screen displays a full screen of 22 lines of help text per
  760.  screen, a border, screen title (if available), and a QuikGuide line at the
  761.  bottom of the the screen.
  762.  
  763.  The QuikGuide Line at the bottom of the screen provides the user with the
  764.  necessary instructions to move above about, once inside the Quikhelp system.
  765.  
  766.  In addition any other messages such as "Searching", "No Match", etc. are
  767.  also displayed on the last line of the display.
  768.  
  769. @Search Topic
  770. %aqua,magenta
  771.  
  772.  Screens and Menus can be searched via a "topic".  Search topics are defined
  773.  by using the "@" hook.  The maximum length of a search topic is 127
  774.  characters.  Any mixture of upper, lower case, punctuation, spaces, or
  775.  numbers may be used to create a valid search topic.
  776.  
  777.  Here's an example of some valid search topics:
  778.  
  779.                  ╒══════════════════════╕
  780.                  │ Search A             │
  781.                  │ Search-B             │
  782.                  │ "Search A"           │
  783.                  │ Search 1.1           │
  784.                  │ Topic Utility Guide  │
  785.                  │ guide1               │
  786.                  │ GUIDE1               │
  787.                  │ Guide1               │
  788.                  ╘══════════════════════╛              ┌─────────────────┐
  789. >                                                      │  [Main Menu 1]  │
  790. >                                                      │   Main Menu 2   │
  791.                                                        └─────────────────┘
  792. ^
  793.  
  794.  ALL HOOKS MUST BE PLACED IN COLUMN 0.
  795.  
  796.  Column 0─┐
  797.           │
  798.           
  799.  Example: @Employee Data
  800.  
  801.  
  802.       ┌──────────Employee Data───────────┐
  803.       │                                  │
  804.       │           First Screen           │
  805.       │                                  │
  806.       └──────────────────────────────────┘
  807.  
  808.  
  809. ^
  810.  
  811.                            Search Topics & Clipper
  812.  
  813.  Usage for the search topic under Clipper:
  814.  
  815.                       ╒══════════════════════════════╕
  816.                       │  QHtopic("Search topic")     │
  817.                       ╘══════════════════════════════╛
  818.  
  819.  
  820. @Example of Use
  821. %red,white
  822.  
  823.  Quikhelp will assume a default help file name of "Quikhelp.hlp" if none is
  824.  given.  However, any file and any valid DOS file name may be opened as a
  825.  Quikhelp help file.  Only one help file may be open at a time however.
  826.  
  827.  
  828.  
  829.  
  830.  
  831.  
  832.     ┌─────────────────┐
  833. >   │  [Main Menu 1]  │
  834. >   │   Main Menu 2   │
  835.     └─────────────────┘
  836. ^
  837.  
  838.                                   Example  
  839.                                   ═══════  
  840.   The following example shows how an application in dBASE can provide help
  841.  to several different levels of users depending on each user's level of
  842.  expertise.
  843.  
  844.  
  845.  
  846.   novice = .t.
  847.    if novice 
  848.         ! novice.exe (Clipper created)
  849.    else
  850.         !qh expert.exe (Clipper created)
  851.    endif
  852.  
  853.     ┌─────────────────┐
  854. >   │  [Main Menu 1]  │
  855. >   │   Main Menu 2   │
  856.     └─────────────────┘
  857. @Error Messages
  858. %aqua,black
  859.                                 Error Message
  860.               ╒═══════════════════════════════════════════════╕
  861.               │  "QuikHelp file cannot be opened: <helpfile>" │
  862.               ╘═══════════════════════════════════════════════╛
  863.  Probable Causes:
  864.         1. Help file doesn't exist.
  865.         2. File damaged.
  866.         3. Out of available file handles or memory to open
  867.            another file.
  868.                                 Error Message
  869.                                ╒═════════════╕
  870.                                │ "No Match"  │
  871.                                ╘═════════════╛
  872.  Probable Cause:
  873.         1. Invalid Help Search Topic.
  874.         2. Index file not up to date.
  875.            Remedy: Simply delete the ".QHX" file associated with the
  876.            help file used.  Quikhelp will automatically rebuild a new one.
  877.                                              ┌─────────────────┐
  878. >                                            │  [Main Menu 1]  │
  879. >                                            │   Main Menu 2   │
  880.                                              └─────────────────┘
  881.  
  882.  
  883.  
  884. @Versions 1.5/2.0 !!
  885.                      ** "C" Enhanced QuikHelp **
  886.     That's right, a "C" enhanced version!  
  887.  
  888.     The previous version, Beta Release 1.0 and the current version
  889. Release 1.1 are both written entirely in Clipper Summer '87.  Being
  890. Clipper purists, we took this approach first for two reasons: First,
  891. and foremost we know Clipper better; and second we wanted to
  892. demonstrate that a powerful, full-featured, integrated library could
  893. be developed entirely in Clipper *without* resorting to Assembly or
  894. "C" language routines.
  895.  
  896.     However, as developers we want four things: Accuracy, Speed,
  897. Speed, and still more Speed!  So, in the design stages right now are
  898. two versions scheduled for release in January 1989.  First, the "C"
  899. enhanced version of QuikHelp (Release 1.5) which will maintain much
  900. of the original Clipper code but will use an assembler routine for
  901. direct video writes for *BLAZING* screen I/O, and either some "C" or
  902. assembler algorithms for still faster searching and indexing.
  903.                                              ┌─────────────────┐
  904. >                                            │  [Main Menu 1]  │
  905. >                                            │   Main Menu 2   │
  906.                                              └─────────────────┘
  907. @Release 2.0
  908.  
  909.  
  910.     The step beyond mixing Clipper with "C" and assembler takes us to
  911. the quintessential QuikHelp version:  a linkable library written
  912. entirely in "C" and Assembler, *plus*  a stand-alone executable
  913. version of QuikHelp for non-Clipper related reference facilities.
  914.  
  915.  
  916.                                              ┌─────────────────┐
  917. >                                            │  [Main Menu 1]  │
  918. >                                            │   Main Menu 2   │
  919.                                              └─────────────────┘
  920.  
  921. @The Wish List
  922.  
  923.     Based on user feedback during the Beta period, the following
  924. items have been suggested for incorporation into future releases of
  925. QuikHelp:
  926.  
  927.               o  User-definable Screen Sizes
  928.               o  Scrolling within a page
  929.               o  Incremental Searching
  930.               o  Faster Indexing
  931.               o  Faster Searching
  932.               o  Automatic Text to QuikHelp Conversion
  933.               o  On-line QuikHelp Editor 
  934.                  ( Use QuikHelp to update the Quikhelp File! )
  935.               o  Norton-Guides File Compatibility
  936.                                              ┌─────────────────┐
  937. >                                            │  [Main Menu 1]  │
  938. >                                            │   Main Menu 2   │
  939.                                              └─────────────────┘
  940. @Free Support Policy
  941.  
  942.     Because QuikHelp has been developed using the K.I.S.S. concept,
  943. there has been only a minimum of support required.  However, as its
  944. complexity and range of utility increase, so, we anticipate, will its
  945. amount of required support.
  946.  
  947.     As a small (currently three person) development company, we
  948. simply do not have the resources to provide a separate support team. 
  949. We *ARE* the support team, the development team, the secretarial
  950. team, the marketing team, the research team, etc..   Consequently, we
  951. will provide *FREE* unlimited developer support, to all *registered*
  952. users, on a returned call, reversed charges basis.  
  953.  
  954.     Our voice mail service is available 24 hours a day, 365 days a
  955. year.  *Every* call is returned as quickly as possible, during normal
  956. business hours (PST).  A personal, extremely knowledgable (after all,
  957. we wrote it!), support person will do everything possible to assist
  958. you with your request. 
  959. ^
  960.     In addition, we maintain an Electronic Mail Box with MCI Mail
  961. that is also available.
  962.  
  963.                     MCI Mail Box # ...: 650-318-9786
  964.                     24-Hour Voice mail: (619) 542-1200
  965.                                              ┌─────────────────┐
  966. >                                            │  [Main Menu 1]  │
  967. >                                            │   Main Menu 2   │
  968.                                              └─────────────────┘
  969. @Trademarks
  970. %red,aqua
  971.  
  972.  IBM is a trademark of International Business Machines.
  973.  dBASE is a trademark of Ashton-Tate 
  974.  Wordstar is a trademark of Micropro Inc.
  975.  
  976.  
  977.     ** A Little About DataBex **
  978.  
  979.     Since 1982...
  980.  
  981.     We have been designing, developing and supporting business
  982. applications and systems on microcomputers in the United States since
  983. 1982 and internationally since 1984.
  984.  
  985.     ┌─────────────────┐
  986. >   │  [Main Menu 1]  │
  987. >   │   Main Menu 2   │
  988.     └─────────────────┘
  989.  
  990.