+-----------------------------------------------------------------------------+ The line above should be centered and one-inch below the top of form. - THE KEYSAVER MANUAL TEXT FOLLOWS - +------------------------------+ | tm | | KEYSAVER | | | | TYPING ASSISTANT | | | | Copyright 1993 | | | | HFK Software | | Sixty-Eight Wells Road | | Lincoln, MA 01773 | | | | 617-259-0059 | | | +------------------------------+ Version 1.0 11-5-93 T A B L E o f C O N T E N T S INTRODUCTION 1 INTRODUCTORY DEMO 1 SYSTEM REQUIREMENTS 2 INSTALLATION 2 TSR LOADING 2 TEMPLATE FILES 3 TRIGGERING KEYSAVER 4 KEYSAVER EXERCISES 4 EXERCISE-ONE 5 EXERCISE-TWO 6 CONSTRUCTING TEMPLATES 6 KEYSAVER REGISTRATION 7 APPENDIX-A -- TEMPLATE-1 LISTING 8 APPENDIX-B -- TEMPLATE-2 LISTING 9 APPENDIX-C -- COMMAND SUMMARY 10 APPENDIX-D -- SHAREWARE DECLARATION 11 REGISTRATION FORM 12 -- I N T R O D U C T I O N -- KEYSAVER, the typing assistant, provides a means of auto- matically typing boiler plate (commonly used) text at will. This not only saves a great deal of repetitive typing, but also eliminates the associated risk of misspelled words and other typos. KEYSAVER works transparently with WordPerfect, DOS, and other text oriented programs. That is, the program (e.g., Word- Perfect) does not know that you did not actually key the boiler plate text manually. KEYSAVER uses standard ASCII files called templates to contain sets of boiler plate and related prompt text. KEYSAVER's operation is deceptively simple. KEYSAVER is "triggered" to initiate the auto-typing of boiler plate text. When the boiler plate, which may vary from a single character to multiple paragraphs, is auto-typed the prompt that follows the boiler plate in the template is displayed. This prompt usually indicates what unique keystrokes are required following the just auto-typed boiler plate. When the manual input of unique text is completed, KEYSAVER is triggered again, the next boiler plate is auto-typed, and the next prompt is displayed. This cycle may continue until an entire document has been typed. KEYSAVER has been designed to work with speech and large print systems used by the blind and visually impaired. -- I N T R O D U C T O R Y D E M O -- The details in this manual are more easily understood once you have seen KEYSAVER in action. If you have not already run the MENU batch, you might wish to do so now by: 1. Making sure that your KEYSAVER files are in the current drive/directory, 2. Entering "MENU" on the DOS command line, and 3. Selecting "Demo, Installation, and Exit." This menu provides a means of easily printing a manual, installing KEYSAVER, and using KEYSAVER in a simulated work environment. -1- REMEMBER THAT WHEN YOU FINISH MANUALLY ENTERING TEXT, YOU MUST TRIGGER KEYSAVER TO RESUME AUTOMATIC TYPING. After running the introductory demo, you may wish to examine the template file (D.TPL) and relate the file content to the observed actions. -- S Y S T E M R E Q U I R E M E N T S -- KEYSAVER requires about 5K bytes of RAM plus sufficient memory to contain the largest template, and runs under DOS Version-3 or later on an IBM PC or equivalent computer. -- I N S T A L L A T I O N -- KEYSAVER installation is easy. Just copy the KEYSAVER.COM file from your KEYSAVER diskette onto your system disk. -- T S R L O A D I N G -- KEYSAVER is a resident extension of DOS (a TSR) that remains in memory to provide service while other programs are running. KEYSAVER is loaded into memory via a KEYSAVER [] [] command line either entered in response to the DOS prompt or from your AUTOEXEC or other batch file. Note: Optional command line parameters are shown enclosed in square brackets. Hence, is required but and are not. is specified in bytes within the range of 100-40000, and is used to reserve space for a template file. That is, should be as large as the file size of the largest template file that you will be using. (Use "DIR *.TPL" to view your template file sizes.) is optional, and when specified overrides the default trigger SHIFT key combination of CTRL+ALT. is specified as a combination of two shift key names joined by a plus sign. Use "LEFT+RIGHT" for both case shift keys, "CTRL+LEFT" for the CTRL and the LEFT case shift key, ALT+RIGHT for the ALT and RIGHT case shift key, etc. This -2- shift key combination is used to trigger KEYSAVER into action. is optional, and when specified, overrides the default prompt display colors of white text on a red background. is specified as a text color, a plus sign, and a background color. KEYSAVER accepts RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, BLACK and WHITE as colors. Entering "KEYSAVER 1000 CTRL+LEFT WHITE+GREEN" loads the KEYSAVER TSR, reserves 1000 bytes for template storage, sets the CTRL and LEFT shift keys for triggering, and sets the prompt display colors to white text on a green background. Attempting to load KEYSAVER again does nothing unless "KEYSAVER UNLOAD" is entered, in which case the TSR is removed from memory and KEYSAVER may then be reloaded. The ability to unload the KEYSAVER TSR provides flexibility for special cases. Normally KEYSAVER is loaded once via a line in the AUTOEXEC batch file and is never unloaded. If you must unload a TSR, be sure to follow the convention of unloading TSRs in reverse order (last loaded, first unloaded). -- T E M P L A T E F I L E S -- KEYSAVER uses standard ASCII files called templates to contain boiler plate text and the prompts that follow. Each prompt is enclosed in braces and implies the end of boiler plate text. The following template Name: {TYPE NAME}Account Number{TYPE ACCOUNT} <----> <-------> <------------> <----------> | | | | 1st Boiler Plate -+ | | | 1st Prompt ----------------+ | | 2nd Boiler Plate ----------------------+ | 2nd Prompt ------------------------------------------+ contains two sets of BOILER PLATE/PROMPT text that drive KEYSAVER as follows. After "Name: " is auto-typed, a "TYPE NAME" prompt is displayed. After you respond by typing a name and triggering KEYSAVER again, a "TYPE ACCOUNT" prompt is displayed. -3- Template files always have a single character name and a ".TPL" extension (e.g., A.TPL). -- T R I G G E R I N G K E Y S A V E R -- KEYSAVER is triggered by holding the both trigger shift keys (default CTRL+ALT) down together. If a template HAS NOT BEEN SELECTED, holding the trigger shift keys down (for any period of time) causes a prompt for a template to be displayed and a template ID (file name) to be accepted. If the specified template file exists: (1) the template is selected, (2) the first boiler plate text is auto-typed, and (3) the first prompt is displayed. If a template HAS BEEN SELECTED and the trigger shift keys are held for LESS THAN one-half second: (1) the next boiler plate text is auto-typed, and (2) the next prompt is displayed. If a template HAS BEEN SELECTED and the trigger shift keys are held for MORE THAN one-half second, the template selection is cancelled, a prompt for another template is displayed, and a template ID is accepted. If the specified template file exists: (1) the template is selected, (2) the first boiler plate text is auto-typed, and (3) the first prompt is displayed. Holding a trigger for more than one-half second insures auto-typing from the beginning of a template. Holding a trigger for less than one-half second continues the auto-typing from a selected template. -- K E Y S A V E R E X E R C I S E S -- The following two exercises illustrate KEYSAYER's use and suggest it's power. To perform these exercises copy files KEYSAVER.COM, 1.TPL and 2.TPL from your KEYSAVER diskette onto your system disk and load KEYSAVER via a "KEYSAVER 1000" DOS command. For example: C:\DIRECTORY>COPY A:KEYSAVER.COM C:\DIRECTORY>COPY A:*.TPL C:\DIRECTORY>KEYSAVER 1000 -4- The content of the template files (1.TPL & 2.TPL) is listed in Appendix-A and Appendix-B. -- E X E R C I S E - O N E -- Once KEYSAVER has been loaded, it may be triggered into action by depressing both trigger shift keys and then releasing them. Begin by starting your word processor and proceeding to the point where it is ready to accept document text. Then, trigger KEYSAVER by holding CTRL+ALT until prompted for a template. Strike the 1-key to select Template-1 (file 1.TPL). KEYSAVER will respond by: (1) auto-typing the text from the beginning of the file through the prompt, and (2) displaying the prompt text. Template-1 begins with a prompt, so no keystrokes are auto-typed before the first prompt is displayed. That is, in this case, THE FIRST PROMPT IS USED AS A TEMPLATE TITLE WHICH ALLOWS YOU TO BE SURE THAT YOU HAVE SELECTED THE CORRECT TEMPLATE BEFORE ANY TEXT IS AUTO-TYPED. Proceed by triggering (CTRL+ALT) again. Template-1 causes a memo header to be auto-typed followed by a prompt for a date. Type the date as requested. Do not terminate the date with an ENTER, Template-1 will do it for you. (You might prefer to construct templates that require the ENTER to be struck.) Continue by triggering and responding three more times. The boiler plate used in Exercise-1 consists of relatively short text strings. In practice, boiler plate may consist of very long strings and contain formatting commands (margins, tab stops, line spacing, etc.) and special characters. A system of multiple templates might be designed. For, example one template to auto-type a common letter beginning (formatting, heading, date, salutation, etc.), with the remainder providing boiler plate for specific types of correspondence. Exercise-2 deals with this type of template continuation. -5- -- E X E R C I S E - T W O -- When a template IS SELECTED and the trigger shift combination is held for more than one-half second, the template selection is cancelled and you are prompted for another template ID. Therefore, when you wish to start a new template simply hold the trigger shift keys down until prompted for a template. Template-1 begins with a prompt (instead of text to be auto- typed) that serves as a template title. By displaying this title before any text is auto-typed, the template permits an easy re-selection (by holding a trigger for more than one- half second) when an incorrect template is selected. As with Exercise-1, start a new document and select Template-1. Proceed through the third prompt "Type SUBJECT." Then, instead of responding by typing a subject description, switch to Template-2. That is, hold the trigger until prompted for a template and then strike the 2-key. Note that Template-2 does not use a confirmation title but rather begins auto-typing boiler plate immediately. Follow the prompts and complete the document via Template-2. -- C O N S T R U C T I N G T E M P L A T E S -- KEYSAVER template files are standard ASCII files that may be prepared with virtually any word processor or text editor. The only thing special about template files is that their names must consist of a single character and they must have a .TPL extension. CARRIAGE RETURN, LINE FEED, TAB, and other control characters are ignored by KEYSAVER and, therefore, may be used to improve the readability of .TPL files. When needed in boiler plate text, the following three character symbols may be used. {E} -- Generates an ENTER keystroke {T} -- Generates a TAB keystroke {B} -- Generates a LEFT BRACE ({) keystroke Note: The left brace character is used to mark the beginning of prompt text and special symbols. Therefore, the special symbol {B} must be used when a left brace is needed within boiler plate. -6- Additional special keystrokes may be specified via a six character symbol, e.g., {011B} to create an ESCAPE keystroke. These special symbols may be determined by entering KEYSAVER DISPLAY_CODES on the DOS command line and then striking the desired keys. Special display codes may be included in prompt text via the five character symbol {DDD} where DDD is the decimal display code for the desired character. Template-2 uses {172} to produce the 1/4 character. Display codes are listed in hardware reference manuals. -- K E Y S A V E R R E G I S T R A T I O N -- KEYSAVER is a complete package that is provided as SHAREWARE (see Appendix-D). Enjoy getting to know KEYSAVER and understanding the benefits it provides. Feel free to make copies for your friends and co-workers. When you put KEYSAVER to practical use, a $20 registration fee is due. A convenient registration form is included. Please be sure to include a phone number so that we may contact you if an order processing question arises. When you register: (1) you will receive a KEYSAVER.COM that displays your personal name instead of "UNREGISTERED USER" and (2) you will be entitled to phone support. Note-1: This offer is subject to change without notice. Note-2: Use of KEYSAVER within a commercial product requires a software license. -7- K E Y S A V E R A P P E N D I X - A T E M P L A T E - 1 L I S T I N G ------------------------- File 1.TPL ------------------------ {MEMO TEMPLATE} {E}{E}{E} HFK Software{E} Sixty-Eight Wells Road{E} Lincoln, MA 01773{E} {E} {E} Date: {Type DATE}{E} {E} To : {Type RECIPIENT'S NAME}{E} {E} From: Hank{E} {E} Subj: {Type SUBJECT}{E} {E}{E}{Enter MEMO TEXT} {FINISHED} ------------------------- File 1.TPL ------------------------ Prompt text is enclosed in braces (e.g., {Type DATE}) and the special symbol {E} within boiler plate generates an ENTER keystroke. This template begins with a prompt ({MEMO TEMPLATE}). That is, the first boiler plate does not exist and, therefore, nothing is auto-typed until the prompt is displayed and KEYSAVER is triggered again. Thus, the prompt serves as a template title and allows you to verify that the correct template has been selected BEFORE any text is auto-typed. RETURNs are used in the template file to approximate the appearance of the resultant auto-typed boiler plate. While this is generally a good idea, you could construct the file as one long string of characters. -8- K E Y S A V E R A P P E N D I X - B T E M P L A T E - 2 L I S T I N G ------------------------- File 2.TPL ------------------------ Time Sheet{E}{E}{E} MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY{E} {Enter daily times (within {172}-hour)}{E} {E} ------------------------------------------------------{E} {E}{E}{E} _____________________________________ ________{E} (signature) (date){E} {E} {FINISHED} ---------------- -------- File 2.TPL ------------------------ Prompt text is enclosed in braces and the special symbol {E} within boiler plate generates an ENTER keystroke. This template begins with boiler plate text that is auto- typed before the first prompt is displayed. There is no prompt serving as a confirmation template title. The five character special symbol {172} causes a "1/4" symbol to be displayed. -9- K E Y S A V E R A P P E N D I X - C C O M M A N D S U M M A R Y DOS (or BATCH) KEYSAVER COMMANDS To LOAD the KEYSAVER TSR: KEYSAVER [] [] -- LEFT+RIGHT, LEFT+CTRL, ALT+LEFT, etc. -- + Examples: KEYSAVER 3000 KEYSAVER 3000 CTRL+LEFT KEYSAVER 3000 CYAN+BLUE KEYSAVER 3000 CYAN+BLUE CTRL+LEFT To DISPLAY keycode symbols: KEYSAVER DISPLAY_CODES To UNLOAD the KEYSAVER TSR: KEYSAVER UNLOAD KEYSAVER TRIGGERING Holding the SHIFT combination for MORE than 1/2 second: (1) CANCELS any selected template, (2) SELECTS a template (prompts for ID), (3) AUTO-TYPES the FIRST boiler plate (if any), and (4) DISPLAYS the FIRST prompt. Holding for LESS than 1/2 second with NO template SELECTED: (1) SELECTS a template (prompts for ID), (2) AUTO-TYPES the FIRST boiler plate (if any), and (3) DISPLAYS the FIRST prompt. Holding for LESS than 1/2 second with a template SELECTED: (1) AUTO-TYPES the NEXT boiler plate (if any), and (2) DISPLAYS the NEXT prompt. To start with a new template, simply hold the trigger until prompted for a template ID. -10- K E Y S A V E R A P P E N D I X - D S H A R E W A R E D E C L A R A T I O N This product is produced by a member of the Association of Shareware Professionals (ASP). ASP wants to make sure that the shareware principle works for you. If you are unable to resolve a shareware-related problem with an ASP member by contacting the member directly, ASP may be able to help. The ASP Ombudsman can help you resolve a dispute or problem with an ASP member, but does not provide technical support for a members' products. You may contact the ASP Ombudsman via: ASP Ombudsman 545 Grover Road Muskegon, MI 49442-9427 USA FAX: 616-788-2765 or CompuServe Mail: ASP Ombudsman 70007,3536 HFK Software actively supports the goals and principles of the Association of Shareware Professionals. -11- -- K E Y S A V E R R E G I S T R A T I O N F O R M -- +-OWNER'S-NAME-(in-place-of-UNREGISTERED-USER):----------------------------+ | (10-35 characters)| +--------------------------------------------------------------------------+ +-MasterCard-or-VISA-account,-check,-or-P.O.-number:----+ +-Expiration:----+ | | | | +-------------------------------------------------------+ +----------------+ +-Signature-if-credit-card-order:---+ +-Phone-number:---+ Diskette: __ | ($20)| | | 3-1/2 inch |__| +-----------------------------------+ +-----------------+ 5-1/4 inch |__| --(fold-back-here)--------------(first-fold)--------------(fold-back-here)-- +-------+ From: ________________________________ | place | | stamp | ________________________________ | here | +-------+ ________________________________ To: +------------------------------+ | | | HFK Software | | 68 Wells Road | | Lincoln, MA 01773-3702 | | | +------------------------------+ --(fold-back-here)--------------(second-fold)-------------(fold-back-here)-- This form may be: (1) folded and placed in a standard business window envelope; (2) folded, taped, stamped, and mailed without an envelope; or (3) FAXed to HFK Software at 617-259-0626. Be sure to include a shipping address (return address above). Massachusetts residents must include state sales tax. Phone orders via: 617-259-0059