; Introductory text file for QUICK HELP / QUICK TEXT.
; To use: Place QHELP and this file in the same directory,
;         then type QHELP from that directory.
;
; IMPORTANT: If creating a QHELP text file for your own use, make a copy
; of DUMMY.HLP, then work only on that copy. THIS file should not be used
; for such purposes. Except as specified in "User-Added Information" 
; section below, no alterations may be made to THIS file. Doing so violates 
; the copyright, and may make this file unusable. Use well, and enjoy.
;
; ^OL5 ^OR75 ^OJ
;
2 August 1989
7
PRINTOK
TITLE:     QHELP/QTEXT USERS MANUAL
                                 USERS  MANUAL

                                   -- for --


                ***********************************************

                             Q U I C K    H E L P
                                    - and -
                             Q U I C K    T E X T

                  The Professional User-File Display Programs

                ***********************************************


                             (c) 1989, J. W. Olsen
                              All Rights Reserved
                          Advocate Enterprises, Ltd.
                                    Chicago
~ (Menu)
         ======================  Run-Time Menu  ======================
         =                                                           =
         =  Q - QUIT Program                                         =
         =  A - ALL SECTIONS of File                                 =
         =                                                           =
         =  1 - Becoming Acquainted with and Installing QHELP/QTEXT  =
         =  2 - Which Program to Use for a Particular Application?   =
         =  3 - Using QUICK TEXT                                     =
         =  4 - Using QUICK HELP                                     =
         =  5 - (User-Added Information)                             =
         =  6 - License Agreement, Credits & Disclaimer              =
         =                                                           =
         =============================================================
~ (Section 1)
          << BECOMING ACQUAINTED WITH AND INSTALLING QHELP & QTEXT >>

    QUICK TEXT and QUICK HELP are invaluable for people who need to explain 
    things  to  others (or to remind themselves!). These  programs  provide 
    easy  ways to prepare text files for use as professional "help"  files, 
    displayable  and/or printable manuals, etc. For example, if you're  the 
    de  facto "computer expert" for your family or office,  preparing  such 
    files offers you the chance to thoughtfully provide your knowledge  and 
    advice in an organized, easily used format. Even better, you need do so 
    only once--freeing YOUR time.

    QTEXT  turns  your  ordinary text  files  into  stand-alone,  instantly 
    executable  ".COM" program files, so you or others later can use  their 
    contents  simply  by typing the file's name--just like any  other  file 
    ending with ".COM". Screens pause where you want them until the user is 
    ready  to  continue,  at which point the screen  clears  and  the  next 
    section is displayed. Users may abort (or pause output) at any time.

    QHELP,  useful  for more extensive files, transforms your text  into  a 
    menu-driven  environment.  (You create the menu near the  beginning  of 
    your  text file to suit your needs.) By a simple, one-word key  at  the 
    head  of the file, you determine whether the user will be  offered  the 
    opportunity to print out the file in a professionally-formatted manner, 
    complete  with  a header line containing useful information  (page  and 
    section numbers, date of last file revision and title of your  choice). 
    Users may display (or optionally print) the entire file or only  chosen 
    sections.  You  also may optionally "hide" a "title page" in  the  text 
    file  which,  along with the menu, will automatically be printed  as  a 
    cover page if a user sends the entire file to the printer,  effectively 
    producing a hardcopy manual.
          Using QHELP--with or without the many available options--you  can 
    turn an everyday text file into a QHELP file in less than five minutes. 
    QHELP  also is capable of running a complete "system" of  an  unlimited 
    number of text files as discussed in Section 4.
          
    Software developers and others who distribute various kinds of computer 
    products  may secure an inexpensive license to use QTEXT or  QHELP  for 
    their own needs. Please contact us with information about your intended 
    use for further details (address/phone in Section 6).

    The README.COM (or similarly-named) file supplied with this release  is 
    a simple example of QTEXT in action. The file you're NOW reading,  when 
    run by QHELP, illustrates QHELP's capabilities.

    By use of QTEXT and/or QHELP, you agree to the terms and conditions  of 
    the License Agreement in Section 6.

    QTEXT and QHELP are currently available for MS-DOS/PC-DOS and more than 
    100  CP/M  computers. A minimum configuration of one disk  drive  (hard 
    disk or floppy) and 128K memory (PC/MS-DOS) or 64K (CP/M) are required. 
    (QTEXT requires only 64K for run-time execution.) For information about 
    QTEXT  and  QHELP for other configurations,  please  inquire.  (Contact 
    information appears in Section 6.)

    QTEXT and QHELP are easy to use, but please take the time to browse the 
    complete manual first to avoid problems before they occur.

    INSTALLATION

    Please  ensure you received all necessary files listed below. (Note  to 
    CP/M users: All ".EXE" file types will be replaced with ".COM".)

    AEORDER.EXE    Displays product descriptions and prints licensing form
    AEORDER.HLP    Text file for AEORDER
    DUMMY.HLP      QHELP.EXE sample/guidelines text file
    MAINHELP.HLP   Text file you're now reading
    QHELP.EXE      One of two main programs; also runs this HELP manual
    QHELP.FOR      One-paragraph summary (for BBS use--optional)
    QHELP.HIS      History of revisions
    QHREADME.COM   Read this file first (updates, introduction)
    QTCLONE.EXE    One of two main programs; creates QUICK TEXT programs
    QTCL-GEN.COM   Second supplied version of QTCLONE (CP/M only)

    If new to ordering software, note that distribution disks don't contain 
    "operating  system  tracks" because of the exceptional costs  we  would 
    have  to pass along. So, to get started, you'll need to make copies  of 
    these files before using them. It's easy. . . .

    HARD  DISK  SYSTEMS: Boot your computer on its hard disk as  usual  and 
    select a directory for all new files. (We suggest separate subdirectory 
    on PC-DOS/MS-DOS systems, separate User Area on CP/M systems. See  your 
    computer  manual if unfamiliar with subdirectories or User Areas.  Note 
    that  associated  programs  expect  to  find  all  files  in  the  same 
    subdirectory  or  User Area.) Then, copy ALL files to your  hard  disk. 
    Now, see "All Systems," below.

    FLOPPY-DISK-ONLY  SYSTEMS:  Format  a blank disk  as  usual,  add  your 
    favorite  file copying utility, and place that disk in drive A:.  Place 
    the  new distribution disk in drive B:. Now, copy all files from B:  to 
    A:. Then see next paragraph.

    ALL  SYSTEMS: Use ONLY the working copies you create.  Thwart  Murphy's 
    Law  by  safely storing the originals--just in case. Now, move  to  the 
    directory containing your new working copies. Then, if accompanied by a 
    program named README.COM (or similar), type that name for  introductory 
    information and notice of enhancements since the last manual update.

    NOTE:  QTEXT  and QHELP use video codes specific to your  computer  for 
    display  purposes. In the unlikely event you receive  an  inappropriate 
    version,  simply  return the original disk for prompt  replacement.  Be 
    sure to tell us the make and model of computer. And, if possible,  send 
    a photocopy of the video codes page from your operator's manual.
           We've  made a conscientious effort to accommodate a broad  range 
    of needs which we've identified and which have been suggested by users. 
    But  enhancements are always possible. We'll work with you if you  have 
    ideas,  difficulties--whatever.  And,  we'll  supply  a   complimentary 
    upgrade containing your suggestions we implement. This benefits you and 
    others. Contact information appears in Section 6.
~ (Section 2)
            << WHICH PROGRAM TO USE FOR A PARTICULAR APPLICATION? >>

    The overriding consideration in selecting between QTEXT and QHELP for a 
    particular  application  generally  is amount of  text  involved.  Most 
    people don't like to be FORCED to scroll through more than two to  four 
    screens  to find the information they seek. For files of  such  shorter 
    length,  consider  QTEXT.  You also may want to  use  it  to  encourage 
    readers to review the ENTIRE text file, as the only way to read the end 
    of the file is to scroll through all preceding material. However, human 
    psychology tells us many people tend to abort rather than read  lengthy 
    material. So if your motive is to compel reading of the complete  file, 
    you're  wise to use QTEXT for lengthy files only when you have a  truly 
    "captive"  audience--e.g.,  subordinates in a business  environment  or 
    VERY interested and committed readers.
          QTEXT  is an exceptionally fast program to load and execute  (far 
    less  than  1 kilobyte, plus your text), and if placed in one  of  your 
    PATH  directories (PC/MS-DOS) or auto-search user areas (many types  of 
    CP/M  systems), your users can obtain information simply by typing  its 
    name no matter where they are on the system. QTEXT also is even  easier 
    than QHELP for the person creating the text files.

    For  longer  files, and especially for files which lend  themselves  to 
    division into logical sections, QHELP is the better choice. QHELP  also 
    is  preferable  if printer output is to be encouraged.  Further,  QHELP 
    provides  both  creator and readers of text files with  more  extensive 
    options, discussed in Section 4.
~ (Section 3)
                            << USING QUICK TEXT >>

    It's difficult to imagine an easier program to use than QTCLONE,  which 
    clones an instantly executable QUICK TEXT program from an ordinary text 
    file in seconds.

    You  need only remember two things to prepare QHELP text files.  First, 
    files  must  be in "ASCII" format, the most standard  text-file  format 
    which virtually any word processor can create. We can't cover all  word 
    processors, but here are examples of procedures involved.
          If  you  use  WordStar, either select  "Nondocument"  instead  of 
    "Document"  mode from the main menu to create your file or, with  later 
    versions  of this word processor, you instead may create your  file  in 
    the more common "Document" mode, then "print" the file to disk with the 
    ASCII printer driver.
          WordPerfect users may create their files as usual, but then  save 
    them to "DOS" format.
          For versions 5.0 or later of either of the above word processors, 
    be  sure NOT to use "fancy" features such as graphics, footnotes,  etc. 
    The word processors drop almost all such material into  never-neverland 
    when outputting to standard ASCII.
          If  you  have further questions about either of  the  above  word 
    processors, or if you use an alternative, see your program manual.  For 
    almost all word processors, the solution is simple and straightforward. 
    Registered QHELP/QTEXT users who still have questions may contact us.

    The  only  other consideration is to select if and where you  want  the 
    screen to pause. QTEXT automatically pauses each time the screen fills. 
    If this meets your needs, you needn't take any special steps to enforce 
    proper pausing.
          Otherwise,  you may place a tilde ("~") at logical  screen  break 
    points (usually between paragraph). When a tilde is encountered,  QTEXT 
    programs  pause,  display a "more" message, then wait for the  user  to 
    press  any  key.  When a key is pressed, QTEXT clears  the  screen  and 
    continues  until the next tilde or the screen is full (whichever  comes 
    first). For best visual appearance, we recommend that tildes be  placed 
    in the FIRST column of a line.
          Why use tilde breaks at all? You will find purposes of your  own, 
    but  here  are a couple of ideas. Your text might  contain  a  "logical 
    unit"  such  as a chart. You might place a tilde above  and  below  the 
    chart so it appears as an unbroken unit. (You might also place an equal 
    number of blank lines above/below the chart to "center" it vertically.) 
    Or, your text might contain "subhead" divisions. By preceding each such 
    division  by a tilde (and possibly a blank line or two), you'll  ensure 
    the  subhead can't appear "orphaned" from its text at the end a  screen 
    even  after future editing of the text file, and you'll achieve a  more 
    professional appearance with each subsection beginning a new screen.

    Tip: Studies show that line lengths less than full-screen width  retain 
    reader  attention. For a more professional look, we also  often  create 
    text in "justified" mode.

    Now  that  you  have  your text file, all that's left  is  to  use  the 
    supplied QTCLONE program to duplicate it and add fast assembly-language 
    code  to  tell  the operating system how  to  display  it--an  entirely 
    automated  process. (CP/M users: QTCLONE.COM creates QTEXT  files  with 
    video codes for your console. QTCL-GEN.COM creates QTEXT files  capable 
    of  running  on ANY CP/M system by omitting some  speed  and  aesthetic 
    display  features  which  require  hardware-specific  codes.  MS/PC-DOS 
    users: QTCLONE.EXE works on all brands; one version "fits all.")
          Simply   place  your  text  file  into  the  same  directory   as 
    QTCLONE.EXE. When you run that program, all you must do is tell it  the 
    names  of  your text file and the self-executable program you  want  to 
    create. After a few seconds, QTCLONE will advise that your new  program 
    is  ready for testing. To do so, simply enter the name you gave it  and 
    ensure  all is to your satisfaction. (All you'll have to  be  concerned 
    with is the position of your page breaks and that you didn't forget  to 
    create the text as a standard ASCII file.)
          That's it--"instant text programs" ready to use!

    Note: Be sure to save your original text files just in case you want to 
    edit them in the future or lose the new program files.
~ (Section 4)
                            << USING QUICK HELP >>

    Unlike QTEXT, QHELP isn't a stand-alone program. Rather, QHELP.EXE  (or 
    QHELP.COM for some systems) executes an unlimited number of text files. 
    This allows many more features, as well as the opportunity to set up  a 
    "system" of related files, as we'll see.

    In  its simplest application, when loaded QHELP first looks for a  text 
    file named MAINHELP.HLP in the current working directory (the one  from 
    which you call QHELP). If found, that file is executed. If not, a  help 
    screen is displayed.
          It  also is possible to run a SPECIFIC QHELP text file (the  name 
    of  which must end with a".HLP" extension). As an illustration, to  run 
    EXAMPLE.HLP  users  would  type QHELP EXAMPLE. (A  disk  drive  may  be 
    specified,  such as QHELP A:EXAMPLE, but PC/MS-DOS  subdirectories  and 
    CP/M user areas are not allowed.)

    If  you're preparing only one QHELP file, you might  consider  renaming 
    QHELP.EXE  (or QHELP.COM) to HELP.EXE (HELP.COM) and naming  your  text 
    file MAINHELP.HLP. Thus, users are presented with your text file simply 
    by typing HELP.
          If  you're  setting  up a system of help files,  we  suggest  you 
    follow   the  above,  with  MAINHELP.HLP  simply  containing  a   brief 
    introduction to each subject covered by a separate help text file, plus 
    the command to execute it. For example, if you are providing help about 
    WordStar, MAINHELP.HLP might have a section with a paragraph about what 
    WordStar  is  and does, then noting that a more  detailed  tutorial  is 
    available by typing HELP WORDSTAR (which runs WORDSTAR.HLP).
          PC/MS-DOS users might even carry this a step further by  creating 
    batch  files. (CP/M users have public domain alternatives to execute  a 
    full command line by typing a single word.) You might have a batch file 
    which will run the command HELP WORDSTAR simply by typing WSHELP.  (See 
    your operator's manual if unfamiliar with batch files. Registered users 
    may call us.)

    Creating  QHELP  text files is easy. The DUMMY.HLP file  supplied  with 
    this  package contains simple, step-by-step instructions to  guide  you 
    through  preparing  your first file. It also  contains  extensive  tips 
    gleaned  from years of experience to add additional polish to your  own 
    QHELP text files. We urge you to begin by PRINTING DUMMY.HLP with  your 
    favorite  word processor or printout program (which we hope is our  own 
    QPRINT program!). Please don't edit DUMMY.HLP until you've reviewed its 
    contents  carefully. As with QTEXT, if you ruin your only copy,  you're 
    outa luck. . . .

    QHELP offers valuable optional features, each determined by a couple of 
    "key  words"  you  may enter near the head of a  text  file  to  tailor 
    features  a  given  file will offer its readers. Each  is  detailed  in 
    DUMMY.HLP.

    Tip: The file you're currently reading is distributed with the name  of 
    MAINHELP.HLP so it will be automatically invoked. We suggest you rename 
    it  to  QHELP.HLP  so you may use QHELP's  default  text-file  name  of 
    MAINHELP.HLP for your own purposes. After such renaming, you of  course 
    must type QHELP QHELP to display this file later.
~ (Section 5)
                       << USER-ADDED INFORMATION >>

    Authorized distributors and licensed end users may add notes and  other 
    information  for  their  purposes  here. Begin  by  following  a  basic 
    computer precaution of editing ONLY a back-up copy of this file. A word 
    processor  capable of ASCII output must be used. (For WordStar,  select 
    "Nondocument" rather than normal "Document" mode from its main menu  to 
    create  your  file. WordPerfect users: Save the output  file  in  "DOS" 
    format.) 

    IMPORTANT:  All text MUST remain below "<< USER-ADDED  INFORMATION  >>" 
    and above the (undisplayed) "~ (Section 6)" to avoid potential  adverse 
    effects when this file is later executed with the HELP program.
~ (Section 6)
                 << LICENSE AGREEMENT, CREDITS & DISCLAIMER >>

    QHELP.EXE,  QTCLONE.EXE (QHELP.COM and QTCLONE.COM for  some  operating 
    systems),   MAINHELP.HLP  and  all  accompanying  materials   (together 
    referred  to as "QHELP" below) are copyright (c) 1986-89, J.W. Olsen  / 
    Advocate  Enterprises,  Ltd., all rights reserved. By use   of   QHELP,  
    user  agrees  to  all  terms  and conditions within this section, which 
    constitute our full agreement.

    J.W. Olsen / Advocate Enterprises, Ltd. has taken due care in preparing 
    QHELP.   However,  no  expressed  or  implied  warranty  of   accuracy, 
    reliability or suitability for any specific purpose or use is  made. In 
    no event shall J.W. Olsen / Advocate Enterprises,  Ltd. be  liable  for  
    damages,  including  incidental  or   consequential damages,  connected 
    with or arising from furnishing, performance, support or use of QHELP.

    Upon  payment of the registration licensing fee, J.W. Olsen /  Advocate 
    Enterprises, Ltd., will provide the latest version of QHELP, 90 days of 
    reasonable telephone and modem access support, as well as  notification 
    of  certain  future  updates and access  to  same  for  copying/mailing 
    charges only ($10 as of this writing).

    You agree not to distribute any registered (as opposed to shareware  or 
    demo)  version  of  QHELP  without  the  expressed,  written permission 
    of the  copyright holder.  Unregistered  users  of any version may  not 
    use  them for financial gain. Others may use them  AT ONE  SITE  or  BY 
    ONE  INDIVIDUAL,  but  NOT  BOTH  (unless  a  corresponding  additional 
    licensing fee has been paid and authorization to more widely distribute 
    QHELP has been expressly provided in writing by the copyright  holder). 
    If you paid the registration fee for an individual/nonprofit copy,  you 
    agree  not to use QHELP in a for-profit corporate setting.  Subject  to  
    the   other  terms  and  conditions,  users  are  authorized  to   make 
    sufficient  copies of registered copies of QHELP for normal use by  the 
    one  individual  or  at the one site. (If  additional  fees  for  wider 
    distribution  have been paid, authorization to make copies  beyond  the 
    above-stated limitation is governed by terms and conditions in  writing 
    by the copyright holder, made a part hereof by reference.)

    Users  who have received a complimentary copy of the  registered  QHELP 
    version may not sell or otherwise transfer it to  another party.  Other 
    users  may  transfer  QHELP  (original disks   only,  in  the  case  of 
    registered  copies)  to another party, provided  such  users  and  said 
    other party agree to all terms and conditions herein, and in all  cases 
    provided  all  QHELP  materials are transferred  together  and  without 
    alteration.  (An individual/nonprofit copy may not be  transferred  for 
    use  in  a for-profit corporate setting.) Further, by transfer  of  any 
    copy  of QHELP, the former licensee agrees to promptly  relinquish  any 
    right  to  further possession, use or ownership of said  copy  and  all 
    duplicates made from same. (Terms and conditions of this paragraph  may 
    be modified by separate written document of the copyright holder, which 
    document is made a part hereof by reference.)

    For  further information and ordering (including extended  distribution 
    rights,  bulk rates and distributorships), see the accompanying AEORDER 
    program, or contact:
                    J.W. OLSEN / ADVOCATE ENTERPRISES, LTD.
                       899 S. Plymouth Court, Suite 504
                               Chicago, IL 60605
                             312/939-3300  (voice)
                312/939-4411 (24-hr. modem telecommunications)


    Credits:
    QHELP, QUICK HELP, QTEXT, QUICK TEXT and QTCLONE are trademarks of J.W. 
    Olsen  /  Advocate  Enterprises,  Ltd.  WordStar  and  WordPerfect  are 
    registered   trademarks   of  MicroPro  Corporation   and   WordPerfect 
    Corporation, respectively. VDE is a trademark of Eric Meyer.
~
