Click here to load reader

Shorthand 8.51 User’s Manual · Shorthand 8.51 User’s Manual ... Reference 49 Shortcut Keys ... Shorthand on a network provided that you have purchased a Licensed Copy for each

  • View
    322

  • Download
    10

Embed Size (px)

Text of Shorthand 8.51 User’s Manual · Shorthand 8.51 User’s Manual ... Reference 49 Shortcut Keys ......

  • Shorthand 8.51Users Manual

    November 2001

    Copyright 2001 OfficeSoft LLCURL: http://www.pcshorthand.com

    This file was converted directly from the Shorthand 8 Help (SH8.HLP) file. Sincea computer program was used to convert it, some of the formatting and fontsmay not appear consistent. This file is supplied for informational purposes only;the Shorthand 8 help (SH8.HLP) file always takes precedence over this file.

    Important: Any prices and license fees shown in this file may not be up-to-date.Always check the Shorthand web site at http://www.pcshorthand.com for latestpricing information.

    This file is copyrighted (c) 2001 by OfficeSoft LLC. You may freely print out thisfile and distribute copies to others but under no circumstances are you permittedto modify it or make additions to this file without the express written permission ofOfficeSoft LLC.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 2

    Table of Contents

    Shorthand for WindowsTM 4

    Ordering and Licensing Information 5Warranty and License Agreement................................................................... 6Licensing and Registration .............................................................................. 8

    Tutorial and Demos 9Quick Tutorial ................................................................................................ 10Demo: Using Shorthand ................................................................................ 12Demo: Using Shorthand Tags ....................................................................... 14Demo: Using Shorthand to Correct Spelling Errors ...................................... 15Demo: Using Shorthand with Borland Delphi ................................................ 16Demo: Using the @INPUTTCL Tag ............................................................. 18

    Basic Topics 19Getting Started .............................................................................................. 20Managing Dictionaries ................................................................................... 26Using Shorthand............................................................................................ 29

    Advanced Topics 32Tags............................................................................................................... 33AutoReplace .................................................................................................. 34Automatic Keyword Completion .................................................................... 37AutoReplace Suggestion Window ................................................................. 38Linking Dictionaries ....................................................................................... 40Protecting Your Dictionaries .......................................................................... 42How to Simulate Underlined or Bold Text ..................................................... 43Inserting ASCII Codes ................................................................................... 44Effect of Keyboard Activity during Playback.................................................. 45Using Shorthand on a Network ..................................................................... 46How to Prevent Certain Characters from Expanding Keywords ................... 47Tcl Scripts ...................................................................................................... 48

    Reference 49Shortcut Keys ................................................................................................ 50Hot Key .......................................................................................................... 51Shortcut Key Codes....................................................................................... 52Tags............................................................................................................... 54Tcl Extension Commands.............................................................................. 74

    Frequently Asked Questions 83Questions on Specifications .......................................................................... 84Questions on Shorthand in General .............................................................. 85Questions on Running Shorthand ................................................................. 87Questions on Inserting Text with Shorthand ................................................. 88Questions on Managing Dictionaries............................................................. 90Questions on Using Shorthand with Microsoft Word..................................... 91

    Troubleshooting and Technical Support 93Technical Support.......................................................................................... 94Compatibility Issues....................................................................................... 95

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 3

    Stuck Keys..................................................................................................... 96Common Problems........................................................................................ 97

    Appendix 99Dictionary Text Dialog Box .......................................................................... 100Preferences Dialog Box............................................................................... 102Links Preferences........................................................................................ 106Text To Type Dialog Box ............................................................................. 107Pick List Input Dialog Box............................................................................ 108Date Input Dialog Box.................................................................................. 109Free Form Input Dialog Box ........................................................................ 110Dictionary Info Box ...................................................................................... 111Tcl Script Dialog Box ................................................................................... 112Define @INPUT Tag Dialog Box ................................................................. 113SHCNV - Shorthand File Converter Utility................................................... 114

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 4

    Shorthand for WindowsTM

    Copyright 1994-2001 OfficeSoft LLC.All Rights Reserved.

    OfficeSoft LLC517 Cobb CourtLa Puente, California 91746

    Web Sitehttp://www.pcshorthand.com

    How to Contact OfficeSoftOfficeSoft LLC keeps costs down and prices low by setting up virtual offices on the Internet. Wecurrently do not offer telephone support and use e-mail as the primary form of communication.Please use one of the following e-mail addresses if you need to contact us:

    Licensing and Ordering Questions [email protected] Support [email protected] and Suggestions [email protected] Questions [email protected]

    TrademarksShorthand for Windows is a trademark of OfficeSoft LLC.Microsoft, Windows, Windows 95, Windows 98, Windows ME, Windows NT, Windows 2000 andWindows XP are registered trademarks of Microsoft Corp.PRD+ is a trademark of Productivity Software. International, Inc.

    What's NewIf you are upgrading from a previous version of Shorthand, please read theSH8WHATSNEW.TXT file for a description of new features.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 5

    Ordering and Licensing Information

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 6

    Warranty and License AgreementIMPORTANT: CAREFULLY READ ALL THE TERMS AND CONDITIONS OF THISAGREEMENT BEFORE USING THIS PROGRAM. USING THIS PROGRAM INDICATESYOUR ACCEPTANCE OF THE TERMS AND CONDITIONS CONTAINED IN THISAGREEMENT.

    CopyrightShorthand 8.x for Windows (the SOFTWARE) is written and copyrighted 1994-2001 byOfficeSoft LLC of La Puente, California ("OFFICESOFT"). The SOFTWARE is copyrightedmaterial and protected by United States laws and international treaties. All violators of thecopyright will be prosecuted to the full extent of the law. You agree to use the SOFTWARE only ifyou had obtained the SOFTWARE from OFFICESOFT or its authorized distributors orrepresentatives. IT IS A VIOLATION OF COPYRIGHT LAWS IF YOU OBTAIN THE SOFTWAREFROM ANYONE OTHER THAN OFFICESOFT OR ONE OF ITS DULY AUTHORIZEDDISTRIBUTORS OR REPRESENTATIVES.

    Copyright for the Tcl .DLL file is covered separately; the copyright notice can be found in theTclReadme.txt file.

    Evaluation LicenseWhen you install Shorthand for the first time on a computer, Shorthand automatically installs a30-day evaluation license. You have non-exclusive right to install and evaluate a copy of theSOFTWARE on any computer for a period of thirty (30) days. If you want to use Shorthandbeyond the 30 day evaluation period, you must either purchase a license or request an extension.If you decide not purchase a license you agree to remove the program from your computer(s) anddestroy all copies in your possession. SHORTHAND MAY STOP WORKING AFTER THEEVALUATION LICENSE EXPIRES.

    Distribution of Unlicensed VersionThe unlicensed version of Shorthand is a shareware program that can be freely uploaded to anypublic bulletin board or Internet site such as Compuserve, America On-Line,www.shareware.com, etc. Shareware distributors may distribute the unlicensed version ofShorthand for a small fee to cover their distribution costs. The items you CANNOT distribute(unless you have purchased an appropriate Site License) are the Registration ID's and SH8.LIClicense files that convert the unlicensed version of Shorthand into a licensed copy.

    Licensed Version of ShorthandIf you had purchased a license, one Licensed Copy of Shorthand may either be used by a singleperson on one or more computers, or installed on a single workstation used nonsimultaneouslyby multiple people, but not both. By purchasing a license you indicate that you have thoroughlyevaluated and tested Shorthand and found it to be acceptable for your particular purposes.

    A Single User or 1-User License gives you one Licensed Copy of Shorthand.

    A Site License grants a single company the non-exclusive right to distribute up to a specifiednumber of Licensed Copies of Shorthand for use within that company only. You may installShorthand on a network provided that you have purchased a Licensed Copy for each workstationthat is connected to the network. Licensed Copies of Shorthand may not be used by persons notemployed with the company that purchased the site license.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 7

    TransferThe Single User License, Site License, Registration ID's and SH8.LIC License Files are non-transferable to other persons or companies; only the person or company named in the Licensecan use the SOFTWARE with said License.

    TermThis license is effective until terminated. You may at any time terminate this Agreement bydestroying the SOFTWARE and all copies thereof. OFFICESOFT also reserves the right toterminate this Agreement if you fail to comply with any of the terms and conditions herein. ShouldOFFICESOFT terminate this Agreement because of your failure to comply, you agree to destroyor return all copies of the SOFTWARE to OFFICESOFT or its authorized representative.

    WarrantyThe SOFTWARE is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR ANY PARTICULAR PURPOSE. SOME STATES DONOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSIONMAY NOT APPLY TO YOU. THIS WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS ANDYOU MAY ALSO HAVE OTHER RIGHTS WHICH VARY FROM STATE TO STATE. Because ofthe diversity of hardware and software which the SOFTWARE may be used, OFFICESOFT doesnot warrant that the SOFTWARE will meet your needs or that the operation of the SOFTWAREwill be uninterrupted or error free. IN NO EVENT WILL OFFICESOFT BE LIABLE TO YOU FORANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS, OR OTHER INCIDENTALOR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THESOFTWARE. In no event will OFFICESOFT be held liable for the loss or corruption of datacaused by the SOFTWARE. In no event will OFFICESOFT'S liability exceed the purchase priceof the SOFTWARE.

    SOME STATES DO NOT ALLOW THE LIMITATION OF EXCLUSION OF LIABILITY FORINCIDENTAL OR CONSEQUENTIAL DAMAGES SO THE ABOVE LIMITATION MAY NOTAPPLY TO YOU.

    GovernmentThis Agreement shall be governed and enforced by the laws of the State of California. Any actionor proceeding brought by either party against the other arising out of or related to this Agreementshall be brought only in a STATE or FEDERAL COURT of competent jurisdiction located inCalifornia. The parties hereby consent to in personam jurisdiction of said courts.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 8

    Licensing and RegistrationThe Shorthand application is protected by a software time lock. When you first install Shorthand,you will be given a 30 day Temporary License to evaluate the program. If you want to useShorthand beyond the 30 day evaluation period, you will need to register and purchase aLicense. After the evaluation period expires, Shorthand will display reminder notices and/or maystop working until your copy of Shorthand is licensed. Temporary extension passwords areavailable if you need more time to evaluate Shorthand; please contact OfficeSoft if you need anextension.

    There are two kinds of licenses: a Single User (or 1-User) License for individual users and a SiteLicense for company-wide use. After you register you will receive a Registration ID that willconvert your evaluation copy of Shorthand into a licensed copy of Shorthand.

    Single User LicenseThe Single User or 1-User License is intended for individual users. The Single User Licenseallows a single person to copy and run Shorthand on any computer subject to the restrictions inthe Warranty and License Agreement. Licensed users will receive a personalized Registration IDwhich allows Shorthand to work beyond the 30 day evaluation period. Click here to view thelicensing fees.

    Site LicenseIf you have 3 or more people who will be using Shorthand, OfficeSoft offers cost effective SiteLicenses for multi-user or company-wide use. You will receive a Registration ID which enablesyou to distribute licensed copies of Shorthand up to the specified number of users. Click here toview the licensing fees.

    UpgradesSpecial upgrade pricing are available for licensed users of Shorthand 7.x or earlier.

    Registration/Ordering InstructionsPlease visit the Shorthand Web Site for ordering information.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 9

    Tutorial and Demos

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 10

    Quick TutorialIt is recommended that you run this quick tutorial to familiarize yourself with Shorthand.

    Start ShorthandRun the Shorthand application (the filename is SH8.EXE) by double-clicking the Shorthand iconin the Shorthand folder or program group. If you are not licensed, the About box appearsshowing the number of days remaining in your evaluation period. Click the OK button to close theAbout box . Shorthand minimizes itself with its icon in the Windows System Tray (normally foundon the bottom right corner of your computer screen.)

    Access Shorthands Main WindowPress the F10 function key. Shorthand should pop up. Alternatively, you can use your mouse toclick on the Shorthand icon in the Windows System Tray.

    Open a Shorthand DictionaryShorthand keeps its word lists in a dictionary. Shorthand dictionary files have extension .SPF.Open the DEMO1.SPF dictionary by choosing Open from Shorthands File menu.

    Add a New Keyword and Text to the Dictionary1. From the Dictionary menu, choose "Add..." to bring up the Dictionary Text dialog box.2. Enter "FX" in the Keyword box.3. Enter "The quick brown fox jumped over the lazy dog." in the Text to Type box.4. Click the OK button to save the new entry. The new entry should appear in the Dictionary list

    box

    Run Shorthand in the BackgroundRun Shorthand in the background by clicking on the Hide button. Shorthand is now watchingyour keystrokes and ready for use.

    Start Your Word Processor ProgramFor this tutorial we will use the Windows Notepad program as our word processor. If it isn'talready running, run Windows Notepad.

    Don't Touch That Mouse!For the rest of this tutorial, we won't be needing the mouse. For the benefit of touch typists,Shorthand can be used without a mouse. Please put your mouse aside and don't touch it untilthe tutorial is completed.

    Using Shorthand with the Hot Key1. Type the following text into Notepad: "TEST:"2. Press the F10 function key. Shorthand should pop up with the text caret blinking in the

    Keyword box.3. Type "FX" in the Shorthand's Keyword box but don't hit the ENTER key yet!. Note that the

    phrase "The quick brown fox jumped over the lazy dog." automatically appears in the Text toType box.

    4. Now press the ENTER key and watch Shorthand type the long phrase for you.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 11

    Using Shorthand's AutoReplace Function1. Type the following text into Notepad: "fx" (all lowercase). Note that the AutoReplace Window

    pops up either above or below Notepad.2. Press the SPACE bar. Shorthand should replace "fx" with the phrase "The quick brown fox

    jumped over the lazy dog."

    Using Shorthand's AutoComplete Function1. Type the following text into Notepad: "f,," ("f" followed by two commas). Note that the

    AutoReplace Window pops up either above or below Notepad.2. Press the SPACE bar. Shorthand should replace "f,," with the closest keyword that begins

    with the letter "f".

    Using Alt+Ins to Add New Words1. Type the following text into Notepad: "hello".2. Press the Alt+Ins key combination. Shorthand should pop up and display the Dictionary Text

    (Add) dialog box with the word "hello" as both the keyword and Text to Type. Press OK toclose the dialog box and add the word to your dictionary.

    Note: Alt+Ins works only if AutoReplace is enabled and the Alt+Ins box is checked in thePreferences.

    Using Ctrl+Ins to Add a Block of Text1. Use your mouse to highlight (select) a block of text in Notepad.2. While holding down the Ctrl key, press the Insert key twice. The selected text will be copied

    to the clipboard and Shorthand should pop up and display the Dictionary Text (Add) dialogbox containing the contents of the clipboard.

    3. Press OK to close the dialog box and add the block of text to your dictionary.

    Note: Ctrl+Ins works only if AutoReplace is enabled and your word processor uses the standardCtrl+Ins command to copy text to the clipboard.

    Thats It!Congratulations! You now know how to use the basic features of Shorthand! Click the >> buttonat the top of this window to proceed to a more advanced demonstration. If you have problemsplease consult the Frequently Asked Questions section and the Troubleshooting section in thishelp file. If you need help on using this help file please press F1.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 12

    Demo: Using ShorthandThe DEMO1.SPF dictionary included with the Shorthand distribution files demonstratesShorthand's AutoReplace and AutoComplete functions. DEMO1.SPF contains keywordsrepresenting each word in the sentence "The quick brown fox jumped over the lazy dog." For thisdemonstration to work, the "Automatic Keyword Completion" option must be selected in thePreferences box and the AutoReplace box in Shorthand's main window must also be selected.

    Warning: DEMO1.SPF will be overwritten if you reinstall Shorthand. If you modifyDEMO1.SPF, be sure to save it under a different name by choosing Save As fromShorthand's File menu.

    To run the demo:

    1. Open DEMO1.SPF by choosing Open from Shorthand's File menu.2. Make sure that the AutoReplace box (above the Keyword box in the Main Window) is

    checked.3. Open Notepad.4. Type this in Notepad:

    T

    Shorthand should expand this to "The ".

    5. Now try to type this:

    jump..

    Shorthand will expand this to "jumped". This illustrates how you can define keywords forsuffixes by using a non-alphanumeric character as the first character of the keyword. In thiscase we use the keyword ".." (two periods) to represent "ed".

    6. Type this in Notepad:

    s;man

    Shorthand expands this to "superman". This illustrates how you can define keywords forprefixes by using a non-alphanumeric character as the last character of the keyword. In thisexample, the "s;" keyword in DEMO1.SPF is used to represent the prefix "super".

    7. Keywords shorten the number of characters you need to type but require you to memorizethe keywords to use them effectively. To solve this problem, Shorthand has an"AutoComplete" feature that automatically matches the current word to the nearest keywordwhenever you type two or more commas. Try typing the following four characters ("q"followed by two commas and a space) in Notepad:

    q,,

    Shorthand expands this to "quick" which is text of the first keyword in the DEMO1.SPFdictionary that begins with the letter "q". Now try this:

    q,,,

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 13

    Shorthand expands this to "quiet" which is the text of the second keyword in DEMO1.SPFthat begins with "q". If you type four commas after the "q", Shorthand will find the thirdkeyword that begins with "q" and so on.

    Note that "q,,", "qu,,", "qui,," and "quick,," will all be replaced by "quick" in thisexample.

    If you look at DEMO1.SPF you may notice that we defined the text "quick" to be representedby the keyword "quick .". You may wonder why there is an extra space and period at theend of the keyword. The reason is that AutoReplace does not recognize keywords thatcontain spaces; if we had defined the keyword to be simply "quick", Shorthand would insert"quick" whenever we typed "quick". This is obviously redundant so we appended the extraspace and period to make the keyword "invisible" to AutoReplace but still accessible throughthe AutoComplete function.

    8. To quickly add words into the dictionary press Alt+Ins immediately after typing the word youwant to add. Try typing this in Notepad:

    quickly

    Shorthand will add the word "quickly" to the dictionary.

    9. There are times when you want to insert a keyword without expanding it. To do this pressCtrl+Space instead of the Space bar. Ctrl+Space tells Shorthand to insert a space withoutexpanding the keyword To demonstrate this, type the following line in Notepad:

    T

    To expand a keyword without inserting a space, press TAB. This is useful for adding suffixesto end of keywords. To demonstrate this, try typing the following line:

    T refore

    Ctrl+Space is a special AutoReplace command. But what if you want to enter the actualCtrl+Space keystroke? For example, Microsoft Word uses Ctrl+Space to reset the characterfonts; since Shorthand intercepts all Ctrl+Space keystrokes MS Word never receives thekeystroke so how do we send Ctrl+Space to Microsoft Word? The solution is to remap yourkeyboard by defining a keyboard shortcut in Shorthand to simulate Ctrl+Space. Press F10 tobring up Shorthand and look at the keyword named "ctrl + space" in DEMO1.SPF whichdefines Ctrl+Alt+Space as its keyboard shortcut. Whenever you press the Ctrl+Alt+Spacekey, Shorthand will execute the "ctrl + space" keyword which simulates the Ctrl+Space key.To see this in action, bring up Microsoft Word, and try pressing Ctrl+Space andCtrl+Alt+Space a few times to see the difference.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 14

    Demo: Using Shorthand TagsThe DEMO2.SPF dictionary included with the Shorthand distribution files demonstrates how touse input tags to create dynamic text.

    Warning: DEMO2.SPF will be overwritten if you reinstall Shorthand. If you modifyDEMO2.SPF, be sure to save it under a different name by choosing Save As fromShorthand's File menu.

    Open DEMO2.SPF by choosing Open from Shorthand's File menu.

    Input TagsThis example demonstrates the different input fields.To run the Input Example:1. Open or Activate Notepad.2. Press F10 to bring up Shorthands main window.3. Type "INPUT" in the Keyword box.

    Note: Shorhtand inserts long paragraphs in spurts. This is because Shorthand inserts a shortdelay between a specified number of keystrokes to allow Windows to keep up; without thepauses, your application may drop characters. You can change the delay in the Preferencesbox.

    Keyboard SimulationThis example demonstrates Shorthand's ability to simulate most keystrokes with the @KEY tag.To run the Key Simulation Example:1. Open or Activate Notepad.2. Press F10 to bring up Shorthands main window.3. Type "MACRO" in the keyword box.

    Date/TimeThis example demonstrates how to use Shorthand to insert the current date or time.To run the Date/Time Example:1. Open or Activate Notepad.2. Press Ctrl+Alt+N in Notepad.3. Press Ctrl+Alt+D in Notepad.

    Advanced Pick ListsThese examples demonstrate advanced pick lists.To run the Pick List Examples:1. Open or Activate Notepad.2. Press F10 to bring up Shorthands main window.3. Type "PICKLIST1" in the keyword box.4. Press F10 to bring up Shorthands main window.5. Type "PICKLIST2" in the keyword box.6. Press F10 to bring up Shorthands main window.7. Type "PICKLIST3" in the keyword box.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 15

    Demo: Using Shorthand to Correct Spelling ErrorsThe TYPOS.SPF dictionary included with the Shorthand distribution files contains 500+corrections to common typographical errors. This dictionary is included for demonstrationpurposes only and is intended to show how Shorthand can be used to automatically correctcommon misspelled words.

    Warning: TYPOS.SPF will be overwritten if you reinstall Shorthand. If you modifyTYPOS.SPF, be sure to save it under a different name by choosing Save As fromShorthand's File menu.

    To run the demo:

    1. Open TYPOS.SPF by choosing Open from Shorthand's File menu.2. Make sure that the AutoReplace box (above the Keyword box in the Main Window) is

    checked.3. Open Notepad.4. Type this in Notepad:

    don;t

    Shorthand will replace this with "don't".

    AcknowledgmentsMost of the entries in TYPOS.SPF came from a public domain MS Word AutoCorrect file by KenDeifik. The SHCNV.EXE utility was used to convert the MS Word AutoCorrect entries into aShorthand file.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 16

    Demo: Using Shorthand with Borland DelphiThe PASCAL.SPF dictionary included with the Shorthand distribution files contains keywordsrepresenting common words and statements defined in the Borland Delphi (Object Pascal)programming language. The keywords in this dictionary are designed to be used with the DelphiCode Editor.

    Warning: PASCAL.SPF will be overwritten if you reinstall Shorthand. If you modifyPASCAL.SPF, be sure to save it under a different name by choosing Save As fromShorthand's File menu.

    How to Use PASCAL.SPF1. Open PASCAL.SPF by choosing Open from Shorthand's File menu.2. Make sure that the AutoReplace box in Shorthand's Main Window is checked.3. Choose Preferences from Shorthand's File menu and make sure that the "Automatic Keyword

    Completion" option is checked in the AutoReplace tab.4. Open a Delphi unit file by running Delphi.5. Type normally in Delphi. Shorthand will expand keywords as you type in Delphi. The

    keywords in PASCAL.SPF are listed in the table below. You are free to change or add newkeywords as you see fit (if you do, remember to save the file under a different name or elseyour changes may be overwritten if you reinstall Shorthand.)

    If You Type Shorthand Will Insert { or (* the matching } or *)

    == or :: :=:ac : array[low..high] of char;:ai : array[low..high] of integer;:al : array[low..high] of LongInt;:ar : array[low..high] of real;:b : Boolean:c : char:i : integer:l : LongInt:r : real:s : stringa,, Abortap,, Applicationb,, begin end;br,, Breakdo,, do begin end;e,, Exitelse,, else begin end;except,, except end;f,, Falsefinally,, finally end;record,, record end;repeat,, repeat until ;t,, Truethen,, then begin end;try,, try finally end;try,,, try except end;w,, while

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 17

    Other KeywordsPASCAL.SPF also contains numerous Delphi common words (such as "procedure" and"constructor") which are intended for use with Shorthand's Automatic Keyword Completion("AutoComplete") function. AutoComplete finds the nearest keyword whenever you type two ormore commas after a word. For example if you type "pr,,", Shorthand will replace this with thefirst keyword that begins with "pr". If you type "pr,,,", Shorthand will replace this with the secondkeyword that begins with "pr" and so on. As you become more comfortable with Shorthand, youwill find yourself typing less and less characters. For example, with the AutoComplete function,"b,,", "be,," and "begin,," all refer to the same keyword. For new users, typing "begin,," is easyto remember, but as you gain more experience you will learn to type "b,," instead.

    Special Shorthand Keys Press TAB after a keyword to expand the keyword without inserting a space. Press Ctrl+Space after a keyword to insert a space without expanding the keyword. Press Alt+Ins immediately after typing a word to add the word to the dictionary. Press Ctrl+Ins twice after selecting a block of text to add the block of text to the dictionary

    (this works only if you are using the Default Keymapping or Classic IDE Editor setting inDelphi; the Brief and Epsilon emulation settings do not use the Ctrl+Ins command to copy textto the clipboard).

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 18

    Demo: Using the @INPUTTCL TagThe DEMO-TCL.SPF dictionary included with the Shorthand distribution files contains examplesof Shorthand code that use the @INPUTTCL tag. Some of the examples require advancedknowledge of Tcl programming..

    Warning: DEMO-TCL.SPF will be overwritten if you reinstall Shorthand. If you modifyDEMO-TCL.SPF, be sure to save it under a different name by choosing Save As fromShorthand's File menu.

    To run the demo:

    1. Open DEMO-TCL.SPF by choosing Open from Shorthand's File menu.2. Make sure that the AutoReplace box (above the Keyword box in the Main Window) is

    checked.3. Open Notepad.4. Press F10 inside Notepad to bring up Shorthands Main Window.5. Select the age1 entry and press Enter.6. Repeat steps 4 and 5 for each of the other entries in DEMO-TCL.SPF. For each entry,

    Shorthand uses the @INPUTMSG tag to display a short description of what each entry does.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 19

    Basic Topics

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 20

    Getting Started

    Introduction

    BackgroundShorthand is a text/keystroke storage and playback utility designed to work concurrently withmost Windows GUI applications (16 bit or 32 bit) that run under Windows 95, 98, ME, NT 4.0 or2000. Shorthand allows you to associate frequently used words, phrases and keystrokes with amuch shorter command or keyword. Instead of typing in the word or phrase, you simply type thekeyword and let Shorthand insert the associated text directly into the target application. WithShorthand, you can also define shortcut keys (for example, Ctrl+Alt+C) to quickly play back pre-defined text, keyboard macros and launch external programs. Shorthand is not limited totransferring static text, Shorthand supports interactive text and document assembly throughembedded input fields and commands (tags) that allow you to dynamically change the text to betransferred.

    SpecificationsOperating System: Windows 95, 98, ME, NT 4.0 (SP3 or newer) or Windows 2000.Maximum Number of Entries per Dictionary: Limited only by available resources.Maximum Number of Dictionaries: Limited only by available resources.Maximum Number of Characters per Entry: 32,000 characters.

    System RequirementsShorthand is a 32-bit program and uses a minimum of 2 Mb of RAM; at least 32 Mb of installedRAM in your PC is recommended. Shorthand should work fine on any CPU that runs Windowsbut you will probably need at least a 300 Mhz or faster CPU if you are a fast typist.

    How Shorthand WorksYou start Shorthand as you would any Windows application and click on the Hide button to runShorthand in the background. Shorthand will monitor your keystrokes and automatically replacekeywords as you type in your word processor.

    If you cant remember a keyword or need to access Shorthand, you simply press Shorthands hotkey to bring up Shorthands main window. You select the text you want Shorthand to type for youby entering a keyword or using the mouse to select the text from a list. If you wish, you may editthe text before Shorthand types it into your word processor.

    If you have trouble remembering keywords, Shorthand also has an Automatic KeywordCompletion feature that will find the nearest keyword for you.

    Using Shorthand for the First TimeShorthand is designed to be simple to use. It is recommended you walk through the theintroductory tutorial to get a feel of how Shorthand works.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 21

    Terminology

    KeywordShorthand uses the term keyword to refer to a word that you define to represent a longer word ortext. Other programs may use the terms alias, "short form," "short cut," "macro name" or"abbreviation" to refer to what Shorthand calls a "keyword. Shorthand only recognizes keywordsyou actually define.

    Text to TypeShorthand uses the term Text to Type to refer to the text associated with the keyword. Otherprograms may use the terms "long form" or "macro" to refer to what Shorthand calls "Text toType."

    DictionaryShorthand stores your keyword/Text to Type entries in a dictionary. You can create more thanone dictionary but only one can be active at any time. Other programs may use the terms "wordlist," "glossary," or "abbreviation list" to what Shorthand refers to as a "dictionary." Shorthandstores a dictionary in a file with suffix SPF. Only one dictionary may be active at any time.

    Hot KeyThe hot key is a special keystroke you type from within your word processor to bring upShorthand. By default, the hot key character is the F10 function key. You can change the hotkey character in the Preferences dialog box.

    File ShortcutA file shortcut is a special keystroke for launching a file. You define file shortcuts in thePreferences dialog box.

    Keyword ShortcutA keyword shortcut is a special keystroke to represent a keyword. You can define a keywordshortcut when you create or edit a dictionary entry.

    Registration IDWhen you purchase a license, you will be assigned a Registration ID which consists of thefollowing three pieces of information: USER ID, # OF LICENSED USERS, and a LICENSE ID.The User ID is normally based on your name and address. The number of licensed users specifythe maximum number of users for a site license. The License ID is a unique code which identifiesyou in our records. To complete your registration you should click the Register button inShorthands About box and enter your Registration ID exactly.

    Important: You should print out and keep your Registration ID in a safe place. You willneed to reenter your Registration ID if you upgrade to a new Windows version or get anew computer.

    SH8.LIC License FileA License File (named SH8.LIC) contains your Registration ID and saves you the trouble ofentering the Registration ID manually. A License File may given to those who purchase SiteLicenses to make it easier for companies to distribute licensed copies of Shorthand. If you

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 22

    receive a SH8.LIC license file, you should place it in the same directory as the Shorthand(SH8.EXE) program. Shorthand automatically detects the presence of license files whenever youstart Shorthand. If you dont have a SH8.LIC License File, one will be created by Shorthand afteryou enter a valid Registration ID in Shorthands Registration box. Please note that the SH8.LICfile contains your license and may not be distributed to unlicensed users.

    Tip: You can revert Shorthand to an unregistered version by simply deleting the SH8.LICfile from the computers hard disk. The SH8.LIC file is located in the same directory asthe Shorhtand program files.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 23

    Starting ShorthandStart Shorthand as you would any Windows applications by choosing it from the Windows Startbutton or clicking its icon from within the Windows Explorer. Shorthand displays an icon in theWindows system tray while it is running.

    Tip #1: If you place the Shorthand icon into the Windows Startup Folder, Shorthand will beautomatically executed whenever you start Windows.

    Tip #2: Shorthand usually works best if it is loaded last; that is, run Shorthand after you haverun all other programs.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 24

    The Main WindowThe Main Window consists of the Main Menu, Keyword Panel and Dictionary Panel. You canresize the Keyword Panel and Dictionary Panel by dragging the Separator Bar that appearsbetween the panels.

    The Main Menu

    File MenuProvides functions to create, open and save dictionary files. Also provides functions to changepreferences and print the dictionary contents to a file.

    Dictionary MenuProvides functions to add, modify or remove dictionary entries and shortcuts. You can duplicatean existing entry or move one or more dictionary entries from one dictionary to another using theCopy and Paste commands. You can search for text with the Find and Search Again commands.You can also enable/disable links copy protect the dictionary and display the Dictionary Info Boxfrom this menu.

    Shortcut MenuDisplays the file shortcuts you defined in the Preferences box. With file shortcuts, you can open aShorthand dictionary file or launch an external program with a single keystroke.

    Help MenuProvides help information functions. Use the About Box to register or display information aboutthe program. Use the Statistics box to find out how many keystrokes Shorthand saved you.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 25

    The Keyword Panel

    Keyword BoxEnter the keyword of a dictionary in this box. You can use the Up and Down Arrow keys to scrollthrough the keyword list; use the Ctrl+Left Arrow and Ctrl+Right Arrow keys to changedictionaries.

    AutoReplace BoxIf this box is checked, AutoReplace will be enabled.

    Text To Type BoxThe text associated with the keyword you entered or selected in the Dictionary list box appears inthe Text to Type box. You can edit the text in this box to make temporary changes that will not besaved to the dictionary.

    Type It ButtonClick this button to command Shorthand to "type" the contents of the Text to Type box into yourword processor. The button is disabled if Shorthand was not activated from your word processor.

    Tip: Pressing the Enter key is equivalent to clicking the Type It button.

    Hide ButtonClick this button to tell Shorthand to minimize itself and run in the background. When Shorthandis running in the background, it will monitor your keystrokes and expand keywords as you type ifAutoReplace is enabled.

    Tip: Pressing the Esc key is equivalent to clicking the Hide button.

    The Dictionary Panel

    Speed ButtonsThe speed buttons allow you to conveniently open a dictionary, save a dictionary, add a newentry, edit an existing entry, remove an entry, enable links and access the Preferences box.Moving your mouse over a button will display a hint on what the button does.

    Dictionary List BoxDisplays keywords, shortcuts and their associated text of the active dictionary. You can togglethe display of the shortcuts by choosing Show Shortcuts from the Dictionary menu. You canaccess the Dictionary menu by clicking the right mouse button inside the Dictionary List. You canresize the columns by dragging the column separator line in the title row. The color of thecharacters in the keyword column may be changed in the Display page of the Preferences box.

    Dictionary File TabsDisplays the names of the most recently opened dictionary files. The tabs allow you to quicklyopen a dictionary by simply clicking on a tab. You create a new tab by choosing Open or Newfrom the File menu. You remove the active tab by choosing Close from the File menu. You canreorder the tabs by dragging and dropping a tab with the left mouse button.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 26

    Managing Dictionaries

    Opening a DictionaryYou can open a dictionary through one of several ways:

    1. Choose Open from the File Menu

    - OR -

    2. Click the button in the Dictionary Panel.

    - OR -

    3. With the mouse over the Dictionary List Box, click the right mouse button and choose OpenFile.

    - OR -

    4. In your word processor, press the file's shortcut key to activate Shorthand and open the file.

    Adding New Entries to the DictionaryThere are 4 ways to create a new dictionary entry:

    1. Choose Add from the Dictionary Menu

    -OR-

    2. Press the Ins key in Shorthands main window.

    -OR-

    3. Press the Alt+Ins key from inside your word processor. (Note: For this to work, AutoReplacemust be enabled and the Alt+Ins option must be enabled in the AutoReplace Preferences.)

    -OR-

    4. Use your mouse to select (highlight) the block of text you want to add in your word processorthen press Ctrl+Ins twice. (Note: This works only if your word processor recognizes theCtrl+Ins command to copy text to the clipboard.)

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 27

    Duplicating an EntryYou can duplicate (or clone) a dictionary item as follows:

    1. Select the original entry with the left mouse button. (Note: Only one item can be duplicated ata time.)

    2. Choose Duplicate from the Dictionary menu. Shorthand will create a new entry then displaythe Dictionary Text dialog box.

    Tip: Pressing Alt+Ins in Shorthands main window is equivalent to choosing Duplicate fromthe Dictionary menu.

    3. Edit the entry then click OK to save your changes.

    Changing a Dictionary Entry

    You can change an existing entry by first selecting the entry in the Dictionary list box thenchoosing Modify from the Dictionary menu.

    Tip: Pressing the F2 key is equivalent to choosing Modify from the Dictionary menu.

    Removing a Dictionary Entry

    How to Remove a Single Entry from the DictionaryYou can remove an entry from the dictionary by first selecting the entry in the Dictionary list boxthen:

    Choosing Remove from the Dictionary menu.

    -OR-

    Pressing the Del key.

    Tip: If you make a mistake, you can restore the deleted entry by choosing Paste fromthe Dictionary menu.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 28

    How to Remove a Block of Entries from the DictionaryFirst select a block by clicking on an entry then, while holding down the Shift key, click on theanother entry. All entries between the two entries should now be selected. You can now deletethe selected entries by:

    Choosing Remove from the Dictionary menu.

    -OR-

    Pressing the Del key.

    Tip: If you make a mistake, you can restore the deleted entries by choosing Paste fromthe Dictionary menu.

    Moving Entries to Another DictionaryYou can copy or move dictionary entries to another dictionary by using Shorthands built-inclipboard copy and paste commands as follows:

    1. Select the entry you want to copy with the left mouse button. You can select a block ofentries by holding down the Shift key and clicking on the left mouse button.

    Tip: To select the entire dictionary, Left Click on the first entry, scroll down to the last entrythen Shift+Left Click on the last entry.

    2. Choose Copy from the Dictionary menu to place a copy of the selected item(s) to theclipboard. Alternatively, you can choose Remove from the Dictionary menu to cut theselected items to the clipboard,

    3. Open the destination dictionary by either choosing Open from the File menu or by clicking onthe dictionarys tab if it was previously opened.

    4. Choose Paste from the Dictionary menu to write the contents of the clipboard to the activedictionary.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 29

    Using Shorthand

    Word Expansion As You Type

    This section explains how to use Shorthand to expand words as you type.

    Running Shorthand in the Background

    Run Shorthand in the background by clicking on the Hide button or by pressing Esc anywhere inShorthands Main Window.

    Once it is in the background, Shorthand will monitor your keystrokes and expand keywords asyou type.if AutoReplace is enabled.

    You can access Shorthands main window from within your word processor by pressingShorthands hot key or by clicking on the Shorthand icon in the Windows system tray.

    Aborting PlaybackTo abort text insertion after playback has started, press the Esc key.

    Backing Up Your DictionariesIt is strongly recommended that you make copies of the dictionary files and save them to a floppydisk or tape drive at regular intervals. The dictionary files have the extension ".SPF" .

    After you modify and save a dictionary, Shorthand automatically makes a backup copy of theoriginal file. The backup copy is save to a file with extension ".~SP". You can restore theoriginal data by simply renaming the backup file back to its original name.

    Statistics BoxChoose Statistics from the Help menu to display the Statistics Box. The Statistics box displaysthe following: The approximate number of characters you typed. The approximate number of characters Shorthand typed for you. The estimated time you saved by using Shorthand.

    Warning: The above numbers are approximate and should not be used as a way to getan exact count of characters actually typed.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 30

    Inserting Text from Shorthand's Main Window

    This section explains how to send keystrokes from Shorthands main window to your Windowsapplication.

    Accessing ShorthandBring up Shorthands main window from within your word processor by pressing Shorthands hotkey.

    Important: Shorthand can only insert text into the window from which you pressed thehot key.

    Specifying the Text To TypeIn the Keyword box, enter the keyword of the text you wish Shorthand to type. The textassociated with the keyword appears in the Text to Type box.

    You can also select the Text To Type by:

    Selecting the desired text in the Dictionary list box.

    -OR-

    Pressing the up and down arrow keys in the Keyword box to scroll through the dictionary list.

    Modifying the Text To TypeShorthand must have been activated from within your word processor by pressing the hot key.

    Specify the text to type as described in "Specifying the Text to Type."

    You can edit the text that is to be typed by directly modifying the text in the Text to Type box.

    Tip: You can change the font of the characters in the Text to Type box through the EditorFont button in the Display Page of the Preferences Dialog Box.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 31

    Typing Text Into Your Word Processor

    Please Note! Shorthand always types the text into the active window or the window from whichyou pressed the hot key.

    The text that Shorthand will "type" into your word processor is displayed in the Text To Type box(see "Specifying the Text to Type.")

    If the Text To Type contains {@INPUT} tags, Shorthand will pause to accept before typing thetext.

    To command Shorthand to type the text into your word processor:

    Click the Type It button.

    -OR-

    With the focus in the Keyword box (the text caret must be blinking in the Keyword box), press theENTER key

    -OR-

    Double-click on the text item in the Dictionary list box.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 32

    Advanced Topics

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 33

    TagsShorthand uses special fields called tags that may be embedded in the dictionary's text torepresent special characters and commands. The syntax of a tag is:

    {@tag_name options}

    Notes:1. There must be no spaces between '{' ,'@' and tag_name.2. At least one space must separate tag_name and options.3. Each left brace '{' must have a matching right brace '}'. Use the {@LEFTBRACE} and

    {@RIGHTBRACE} tags if you need to insert non-matching braces.4. Shorthand always processes the input tags ({@INPUT} and {@INPUTDATE}) first. The non-

    input tags (such as {@REM}, {@LONGDATE} and {@DELETELINE}) are always removed orreplaced just before Shorthand transfers the text to the word processor.

    5. Unrecognized tags are typed as is.

    Shorthand recognizes the following tags:

    Date/Time TagsThese tags allow you to insert the current date/time into your text.{@LONGDATE} Inserts current date using Windows long format{@SHORTDATE} Inserts current date using Windows short format{@LONGTIME} Inserts current time using Windows long format{@SHORTIME} Inserts current time using Windows short format

    Keyboard TagsThese tags are used to simulate keystrokes.{@KEY} Simulates a complete keystroke{@KEYDOWN} Simulates a key press.{@KEYUP} Simulates a key release.{@PAUSE} Inserts a pause between keystrokes

    User Input TagsThese tags displays a dialog box and waits for user input.{@INPUT} Displays a text input dialog box{@INPUT} with PickLists

    Displays a pick list input dialog box

    {@INPUTMSG} Displays a message{@INPUTDATE} Displays a calendar input dialog box

    Miscellaneous Tags{@INPUTFILE} Inserts a text file{@INPUTTCL} Executes a Tcl script{@NOSPACE} Prevents a space from appearing after expansion{@DELETELINE} Deletes the entire line that contains this tag{@REM} Used to embed comments in your text definitions{@LEFTBRACE},{@RIGHTBRACE}

    Inserts a left ({)or right (}) brace

    The Shorthand tags are described in more detail in the Reference section.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 34

    AutoReplaceWhen AutoReplace is enabled, Shorthand automatically replaces keywords as you type them inyour word processor; there is no need to press the leading hot key. You enable AutoReplace bychecking the AutoReplace box in Shorthand's Main Window.

    How AutoReplace WorksAs you enter characters in your word processor, Shorthand monitors your keystrokes. When arecognized keyword is detected, Shorthand will generate a visual cue. You can disable the visualand audible cues in the Preferences box. If you press the Enter, Space or Tab key or type a non-alphanumeric character, Shorthand will simulate backspaces to erase the keyword in the wordprocessor and replace it with the keyword's text to type.

    Adding Words to the DictionaryIf AutoReplace is enabled and the Alt+Ins option is enabled in Preferences, pressing Alt+Inswill add the current word into the dictionary. To copy a block of text to the dictionary, use themouse to select (highlight) the text and press Ctrl+Ins twice. This works only if your wordprocessor uses the Ctrl+Ins command to copy text to the clipboard.

    Preventing Keyword ReplacementYou can prevent a keyword from being replaced by pressing Esc or Ctrl+Space.

    AutoReplace Key GroupsAutoReplace classifies keystrokes into five groups:

    1. ALPHANUMERIC CHARACTERS

    This group is composed of all alphabetic and numeric characters plus the underscore("_") character. Shorthand uses the Windows language driver to determine if a characteris part of the alphabet. Keywords are normally composed of alphanumeric characters.

    2. SEPARATOR CHARACTERS

    This group is composed of the visible non-alphanumeric characters used to separatewords. Shorthand will normally expand keywords whenever you type a SEPARATORcharacter after a keyword. SEPARATOR characters include all punctuation marks andnon-alphanumeric characters: . , : ; " ' / ? < > - + = | \ | ( ) { } [ ] ~ ` ! @ # $ % ^ & *

    Note: The comma character is treated differently if the AutoComplete option is enabled.

    3. TERMINATOR CHARACTERS

    This group is composed of the non-visible characters used to separate words. Shorthandwill expand keywords whenever you press a TERMINATOR key after a keyword. TheTERMINATOR keys are:Space, Enter, Tab, Ctrl+Enter, Ctrl+Tab, Shift+Space

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 35

    Important: AutoReplace will not work properly if you select a TERMINATOR key to be ahot key or shortcut key.

    4. CONTROL CHARACTERS

    This group is composed of the command-type keystrokes. Shorthand clears its internalkeystroke buffer whenever you press a Control character. Control characters include:Function keys, arrow keys, Ctrl+keys (except for those defined as Terminators),Shift+Tab, Alt+keys, Insert, Delete, PgUp, PgDn, Home, End, Esc, mouse clicks, and allShorthand shortcut keystrokes

    5. SPECIAL CHARACTERS

    This group is composed of keystrokes which are treated as special commands byAutoReplace. The keys in this group are: Tab, Ctrl+Space, Alt+Ins, Ctrl+Ins,Esc. Pressing Tab after a keyword will expand the keyword immediately (NOTE: Previous

    versions of Shorthand used the Shift+Enter key to expand keywords immediately; it isrecommended you now use the Tab key instead of Shift+Enter.)

    Pressing Ctrl+Space after a keyword will insert a space without expanding the keyword. Pressing Alt+Ins will add the current word to the dictionary. Pressing Ctrl+Ins twice will add the selected text to the dictionary (this works only if the

    word processor uses Ctrl+Ins to copy text to the clipboard). Pressing Esc will clear the keystroke buffer. The Esc character is passed to the word

    processor only if the keystroke buffer is empty.

    Note: The Preferences box has options to prevent AutoReplace from processing theCtrl+Space and Alt+Ins keys.

    Keyword IdentifiersIn Shorthand, keywords can be any string of up to 32 characters. However, to make a keywordrecognizable to AutoReplace, a keyword must be normally composed of only ALPHANUMERICcharacters. For example abc and 123 are valid AutoReplace keywords, but my macro willnot be recognized by AutoReplace because of the presence of the space.

    SEPARATOR Characters in KeywordsUnder certain circumstances, AutoReplace will recognize keywords that contain SEPARATORcharacters.

    1. A SEPARATOR character will be recognized as part of a keyword if it is identical to thepreceding character in the current word. For example, if you type //, the second / is notconsidered a SEPARATOR character. The purpose of this exception is to allow you to definekeywords such as ,,, to represent common word endings.

    2. A SEPARATOR character will be recognized as part of a keyword if the SEPARATORcharacter is the first or last character of the keyword. For example, asap! and =123 willbe recognized by AutoReplace as keywords. This rule can be used to define keywords withembedded SEPARATORS. For example, a/1 will be recognized as a keyword if you haveanother keyword called a/.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 36

    The best way to understand all this is to experiment with Shorthand and see which keywordswork and which do not.

    Defining Keywords for Prefixes and SuffixesKeywords representing prefixes should normally end with a SEPARATOR character. Keywordsrepresenting suffixes should normally begin with a SEPARATOR character. For example if youdefine s/ to represent "super" and ,t as the keyword for "ite", typing "s/man" will result as"superman" and "krypton,t" will be replaced by "kryptonite".

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 37

    Automatic Keyword CompletionIf you have a hard time remembering keywords when using AutoReplace, Shorthand has anAutoComplete function that automatically finds the nearest keyword for you. You enableAutomatic Keyword Completion ("AutoComplete") by performing the following steps:

    1. From Shorthand's File menu, choose Preferences.2. Select the AutoReplace tab.3. Check the Enable Automatic Keyword Completion box.4. Enable the AutoReplace Window by choosing either the Show Window Only if Keyword

    Detected option or the Always Show Window option.5. Choose OK to close the Preferences box.6. In Shorthand's Main Window, make sure that the AutoReplace box is checked.

    When AutoComplete is enabled Shorthand will find the nearest keyword whenever you type twoor more commas after a word. For example, let's say you have a dictionary that contains thefollowing three entries:

    Keyword Text to Typecompute computecomputer computercomputerize computerize

    Now if you type com,, ("com" followed by two commas), Shorthand will match this to the firstkeyword that begins with "com" which is the "compute" keyword in our example. If you typecom,,, ("com" followed by three commas), Shorthand will match this to the keyword "computer"which is the second keyword that begins with "com". Similarly, com,,,, will be matched to thekeyword "computerize".

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 38

    AutoReplace Suggestion Window

    To enable the Suggestion Window, choose Preferences from Shorthands File menu, choose the4. AutoReplace tab then check the Show Suggestion Window box. The AutoReplace box in theMain Window must also be checked for the Suggestion Window to appear.

    The Suggestion Windows allows you to complete a keyword by pressing a selection key from alist of suggestions. The selection key is F1 for the first suggestion, F2 for second suggestion andso forth.

    Warning #1: When the Suggestion Window is visible, the selection key always takesprecedence over the hot key and other shortcut keys.

    Warning #2: Older computers may not be fast enough to process your keystrokes anddisplay suggestions simultaneously. We suggest you do not display the Suggestion Windowif you experience slow performance.

    Tip: You can change the font of the text in the Suggestion Window as follows: choosePreferences from Shorthands File menu, click on the Display tab, click on the SuggestionFont button.

    Popup MenuYou access the Suggestion Windows options menu by clicking the right mouse button anywherein the window.

    Bring Up Main WindowSelect this option to bring up Shorthands main window.

    Hide TemporarilySelect this option to temporarily hide the Suggestion Window. The Suggestion Window willreappear when you bring up Shorthands main window by pressing the hot key (F10 by default).

    3 Columns/1 ColumnUse these options to select either a 3 column or 1 column format for the suggestions.

    PreferencesSelect this option to bring up Shorthands Preferences dialog box.

    AboutSelect this option to show Shorthands About box.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 39

    ExampleIf you open the DEMO1.SPF dictionary and type an a in your word processor, the SuggestionWindow would look something like:

    The first line shows the contents of the keyboard buffer (i.e. the word you are typing). In theabove example, we had just typed an a.

    The next 3 lines show the 9 nearest matching keywords with the corresponding selection keys(F1 .. F9). In the above example, the nearest matching keyword to a is asap. If you pressF1, Shorthand will replace the a with as soon as possible into your word processor.Similarly, if you press F6, Shorthand will replace the a with fox.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 40

    Linking DictionariesShorthand allows you to access the entries in other dictionarie by linking the contents of anotherdictionary into the active dictionary. The most common use of linking is to place common entries(such as your name) into a separate dictionary and linking this common dictionary to all youractive dictionaries.

    You specify the dictionaries to link as follows:

    1. Choose Preferences from Shorthands File menu.2. Choose the 5. Links tab.3. Enter the dictionaries to link in the list by clicking on the Add button.4. Enable the links by checking the Enable Links box.

    Important: If the Enable Links box is not checked, no linking will occur.

    Linking RulesShorthand follows these rules to link entries:1. All the entries in the active dictionary (i.e. the dictionary which you opened and whose name

    appears in the title bar of Shorthands main window) are loaded first.2. Shorthand then loads in the dictionaries in the order specified in the list shown in the 5.

    Links tab in the Preferences window.3. Duplicate keywords are always ignored and not loaded.4. Duplicate shortcut keys are removed.5. Linked entries are marked read-only and cannot be modified or removed.

    ExampleLinking is best illustrated with an example. Lets say you have three dictionaries set up asfollows:

    D1.SPF: D2.SPF: D3.SPF:a1 = A1 (D1.SPF) a3 = A3 (D2.SPF) a3 = A3( D3.SPF)a2 = A2 (D1.SPF) a4 = A4 (D2.SPF) a4 = A4 (D3.SPF)a3 = A3 (D1.SPF) a5 = A5 (D3.SPF)

    Next, we specify D2.SPF and D3.SPF as linked dictionaries by choosing Preferences fromShorthands File menu, seleting the 5. Links tab, and adding D2.SPF and D3.SPF to the list.The list would therefore contain the following 2 items:

    D2.SPF D3.SPF

    Now if we open D1.SPF (by choosing Open from Shorthands File menu), the Dictionary List inShorthands Main Window would contain the following items:

    a1 = A1 (D1.SPF) a2 = A2 (D1.SPF) a3 = A3 (D1.SPF) a4 = A4 (D2.SPF) a5 = A5 (D3.SPF)

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 41

    Note the following:1. Shorthand loads the dictionaries in the following order: D1.SPF (the active dictionary),

    followed by D2.SPF and D3.SPF.2. The a3 keywords from the D2.SPF and D3.SPF dictionary is not loaded into Shorthand

    because a3 already exists in D1.SPF3. The a4 keyword from the D3.SPF dictionary is not loaded because a4 was already loaded

    from D2.SPF.4. The a4 and a5 keywords are marked read-only and cannot be removed or modified. If you

    wish to modify linked entries you will need to open the dictionary that contains the entry. Forexample, to modify a5, you will need to open D3.SPF.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 42

    Protecting Your DictionariesIf you want to prevent unauthorized access to your dictionary, you can protect the Shorthand(.SPF) file by choosing Protect from Shorthand's Dictionary menu.

    License IDThis is the Shorthand LICENSE ID shown in Shorthands About Box. By specifying a License IDin this box only the user with the specified LICENSE ID can read (but not modify) the file.

    To allow a user who is using an evaluation copy of Shorthand to read (but not modify) the file,enter EVAL as the License ID.

    To allow any user to read and modify the file (i.e. allow unprotected access) , specify a blankstring for the License ID.

    3 LinesYou can enter anything you want in these 3 lines. The information you enter here will bedisplayed when the user chooses Info from Shorthands Dictionary menu. Common uses ofthese lines are to enter your name and copyright information.

    Tip: You can choose Info from the Dictionary menu to view the protection settings.

    Warning: Since the protection scheme is based on the Shorthand License ID, it is importantthat you keep your License ID in a secure place since anyone with access to your License IDmay be able to read your protected files! You can view your License ID by choosing Aboutfrom the Help menu and clicking on the REGISTER button. Losing your License ID mayresult in your inability to access your file.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 43

    How to Simulate Underlined or Bold TextShorthand can only simulate keystrokes and has no concept of the fonts associated withkeystrokes. To simulate changing fonts, you will need to find out the keystroke commands inyour word processor to change to the desired font. For example, Microsoft Word uses Ctrl+B toenable/disable bold face. So to simulate bold text with Shorthand in Microsoft Word, you simplyneed to simulate the Ctrl+B keystroke. Heres an example:

    Keyword: any_keywordText to Type: This is {@KEY Ctrl+B}bold{@KEY Ctrl+B}.

    You can use the same concept to add any formatting codes to your Shorthand text.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 44

    Inserting ASCII CodesYou can insert any ASCII character (including extended characters) by pressing the Alt+ASCIICode combination on the numeric keypad. For example, you can insert the Copyright symbol ""(ASCII Code 0169) as follows: While holding down the Alt key, type "0", "1", "6", "9" on thenumeric keypad.

    Alternative Methods:You can bring up the Windows Character Map Application (CHARMAP.EXE, normally located inthe Windows Accessories folder) and cut and paste the desired character directly into Shorthand.

    -OR-

    You can use your word processor (e.g. choose Symbol from the Insert menu in Microsoft Word)to create the special character then copy and paste the character to Shorthand.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 45

    Effect of Keyboard Activity during Playback

    For most cases Shorthand is able to complete playback before you type your next keystroke.However, if you are a very fast typist or if Shorthand is playing back long paragraphs, it ispossible that you may type a keystroke before Shorthand has finished the expansion. Thissection explains how Shorthand handles your keystrokes when Shorthand is in the middle of atext expansion.

    If you type something while typing a key while Shorthand is playing back text, Shorthand will savemost keystrokes and play them back after Shorthand is finished expanding the text. However,some system keystrokes you make during playback can cause undesired effects:

    Esc KeyPressing the ESC key during playback will abort playback.

    Shift, Ctrl, Alt KeysPressing or releasing the Shift, Ctrl or Alt keys during playback will normally not affect the output.

    Caps LockThe effect of having CAPS LOCK key enabled depends on the method of text transfer. If you usethe Clipboard to transfer text, the CAPS LOCK key has no effect. If the text is transferred throughkeyboard simulation, the state of the CAPS LOCK key affects how the text appears; pressing orreleasing CAPS LOCK while Shorthand during text playback may result in partial caps.

    Num Lock, Scroll Lock, Print Screen, Pause/Break KeysPressing or releasing these keys during playback can cause undesired results.

    Alt+Tab, Windows KeysPressing these keys during playback usually results in activating a new window. For example,Alt+Tab will switch to the next window while WIN+E will bring up the Windows Explorer. SinceShorthand will insert text into the active window, pressing the Alt+Tab or Windows key duringplayback may cause keystrokes to be sent to the wrong window.

    Warning: Sending keystrokes to the wrong window may overwrite or delete data.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 46

    Using Shorthand on a Network

    It is possible to run Shorthand on a network to be shared among 2 or more users simultaneously.

    Installing ShorthandWhen running the SETUP.EXE installation program, we recommend you specify a local directoryto put the Shorthand files. It is possible to install Shorthand into a network directory but this maycause conflicts if you have many people using Shorthand simultaneously.

    Shorthand Dictionary FilesYou can place the Shorthand dictionary (*.SPF) files anywhere on the network. If a dictionary isto be shared by more than one user, we recommend you set the files attribute to READONLY.When Shorthand loads a dictionary, Shorthand does not lock the file so, if the file is not set toREADONLY, it is possible to lose data when 2 or more users make changes to the file.

    Shorthand Configuration FilesBy default, Shorthand stores a users preferences (such as window position and the lastdictionaries loaded) in the Shorthand program directory. You can change the directory where thepreferences will be stored by specifying the new directory in the Shorthand command line asfollows:

    /cfg=

    where:

    is the complete path to the Shorthand executable file (SH8.EXE).

    is the directory to save the configuration files.

    Here is an example: Lets say you have 2 users, John and Jane, who will be sharing Shorthandon the same PC. John has a directory called C:\JOHN on the PC and Jane has directory calledC:\JANE to store her private files. What you will need to do is create two Shorthand shortcuticons; one for John and another forJane. When John wants to start Shorthand, he will simplydouble click on his shortcut icon. When Jane wants to use Shorthand, she will double click onher Shorthand icon.

    The command line associated with Johns shortcut icon would be:"C:\PROGRAM FILES\SHORTHAND FOR WINDOWS\SH8\SH8.EXE" /cfg="C:\JOHN"

    The command line for Janes shortcut icon would be:"C:\PROGRAM FILES\SHORTHAND FOR WINDOWS\SH8\SH8.EXE" /cfg="C:\JANE"

    Note that there are no spaces around the "=" character and double quotes are required toenclose ALL directory names that contain spaces.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 47

    How to Prevent Certain Characters fromExpanding Keywords

    Shorthand will normally expand keywords whenever you type a SEPARATOR character after akeyword. SEPARATOR characters include all punctuation marks and non-alphanumericcharacters: . , : ; " ' / ? < > - + = | \ | ( ) { } [ ] ~ ` ! @ # $ % ^ & *

    You can to prevent a certain character from expanding keywords by modifying theSHORTHND.INI file found in your Shorthand program directory:

    1. Start Shorthand.2. Choose Preferences from the File menu.3. Click OK. This will update your SHORTHND.INI file.4. Shut down Shorthand.5. Use NOTEPAD to open SHORTHND.INI.6. Go to the [PREFERENCES] section in the SHORTHND.INI file.7. Locate the ALPHACHARS= entry. The entry should look something like:

    ALPHACHARS=list_of_characters

    Where list_of_characters can be any string (including a blank string).

    8. Add the characters you wish to prevent expansion to the value of ALPHACHARS.9. For example, if you want expansion to not take place whenever you type a slash (/), colon (:)

    or backslash (\) after a keyword, your ALPHACHARS entry should look like:

    ALPHACHARS=/:\

    Note: Commas are treated differently in Shorthand. If you want to prevent a comma fromexpanding keywords, you will need to do two things: (a) Add the , character to ALPHACHARSand (b) uncheck the Enable Automatic Keyword Completion box in the Preferences window.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 48

    Tcl ScriptsScripts written in the Tool Command Language(Tcl) can be embedded in Shorthand code throughthe {@INPUTTCL} tag. If you are not familiar with Tcl, please consult the TclReadme.txt file formore information on this powerful programming language. Shorthand has extension commandsfor managing your dictionaries as well as some Shorthand parameters.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 49

    Reference

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 50

    Shortcut KeysShortcut keys are special keyboard combinations (e.g. Ctrl+Alt+F1) that can be linked to thekeywords or files. There are four types of shortcuts:

    1. The Hot Key is a shortcut for displaying Shorthands main window and is defined in thePreferences. By default the hot key is the F10 function key.

    2. A Keyword Shortcut is a shortcut for a keyword and is defined in the Dictionary Text dialogbox. Pressing the keyword shortcut is equivalent to typing the keyword.

    3. A File Shortcut is a shortcut for an external file and is defined in the Preferences. Pressingthe File Shortcut will launch that file. If the file is a Shorthand dictionary, the dictionary willbecome the active dictionary. (NOTE: An alternative way to launch programs is to use [email protected] tag.)

    4. A Suggestion Shortcut is a shortcut for selecting an entry displayed in ShorthandsSuggestion Window. Suggestion Shortcuts are recognized only if the Suggestion Window isdisplayed.

    Shortcuts are normally recognized only when Shorthand is running in the background and notwithin one of Shorthands dialog boxes.

    It is possible (but not recommended) to have the same keystroke defined as the hot key, akeyword shortcut and a file shortcut. When you press a recognized shortcut key from within yourword processor, Shorthand uses the following sequence of rules to determine what to do:

    1. If the Suggestion Window is visible, Shorthand first checks if the keystroke is a selection keyfor an entry in the Suggestion Window. If it is, Shorthand immediately types the associatedtext.

    2. Otherwise, Shorthand checks if the keystroke is the hot key. If it is, Shorthands main windowpops ups and displays the current dictionary.

    3. Otherwise, Shorthand checks if the keystroke is a file shortcut. If it is, Shorthand opens orlaunches the file.

    4. Otherwise, Shorthand checks if the keystroke is a keyword shortcut in the current dictionary.If it is, Shorthand immediately types the text associated with that keyword.

    Warning: AutoReplace will not work properly if you select either the Tab key, Backspacekey, Space key or the Enter key to be a shortcut key.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 51

    Hot KeyThe hot key character is a special character you type from within your word processor to bring upShorthand. Shorthand must be running in the background for the hot key to work. By default, thehot key character is the F10 function key. You can change the hot key character in thePreferences dialog box.

    Warning: AutoReplace will not work properly if you select either the Tab key, Backspacekey, Space key or the Enter key to be the hot key.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 52

    Shortcut Key CodesShorthand simulates a keystroke or keystroke whenever it encounters the tag "{@KEY keycode}."For example, "{@KEY TAB}" simulates the Tab key and "{@KEY Shift+F1}" simulates pressingthe F1 key while holding down the Shift key.

    The keycode is composed of a Key Name and one or more optional Prefixes.

    The Prefix can be any combination of the Ctrl, Alt or Shift keys separated by the plus '+'character.

    The Key Name is name of the key. For example, "A" represents the A key. The following tablelists the names of common keys:

    Key Name MeaningA "A" Key4 "4" KeyF1 F1 Function KeyF12 F12 Function KeyTab Tab KeyBkSp Backspace KeyEsc Escape KeyEnter Enter KeyPgUp Page Up KeyPgDn Page Down KeyEnd End KeySpace Space BarHome Home KeyLeft Left Arrow KeyUp Up Arrow KeyRight Right Arrow KeyDown Down Arrow KeyIns Insert KeyDel Delete KeyCaps Caps Lock KeyScroll Scroll Lock KeyPause Pause/Break KeyNumpad/ "/" Key on the Numeric KeypadNumpad* "*" Key on the Numeric KeypadNumpad- "-" Key on Numeric KeypadNumpad+ "+" Key on Numeric KeypadNumpad0 "0" Key on Numeric KeypadNumpad1 "1" Key on Numeric KeypadNumpad9 "9" Key on Numeric KeypadApp Applications Key on Microsoft Natural KeyboardsLwin Windows Key on the left side of the keyboard (some

    keystroke combinations may not work correctly)Rwin Windows Key on the right side of the keyboard

    (some keystroke combinations may not workcorrectly)

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 53

    Notes

    There are no shortcut codes to simulate the following keys/key combinations: NUMLOCK,Ctrl+Alt+Del, and PrintScrn/SysRq. Some combinations involving the Windows key (such asLWIN+E to bring up Explorer) cannot be simulated by Shorthand.

    Some characters (such as "$" which appears on the same key as the "4" key) are shiftedcharacters. For example, you can simulate the $ character with Shift+4.

    Some shortcut codes are keyboard dependent. For example, while Shift+4 is equivalent totyping the '$' character on U.S. keyboards, Shift+4 may represent some other character onEuropean keyboards.

    Use {@KEY Ctrl+Esc} or {@KEY Lwin} to simulate pressing the Start button on the Windowstask bar.

    Keycode Examples:Ctrl+AShift+TabAlt+F1Ctrl+Alt+C

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 54

    Tags

    Tag SyntaxShorthand uses special fields called tags that can be embedded in the dictionary's text torepresent special characters and commands. The syntax of a tag is:

    {@tag_name options}

    Notes:6. There must be no spaces between '{' ,'@' and tag_name.7. At least one space must separate tag_name and options.8. Each left brace '{' must have a matching right brace '}'. Use the {@LEFTBRACE} and

    {@RIGHTBRACE} tags if you need to insert non-matching braces.9. Shorthand always processes the input tags ({@INPUT} and {@INPUTDATE}) first. The non-

    input tags (such as {@REM}, {@LONGDATE} and {@DELETELINE}) are always removed orreplaced just before Shorthand transfers the text to the word processor.

    10. Unrecognized tags are typed as is.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 55

    @DELETELINE Tag

    Syntax{@DELETELINE}

    DescriptionDeletes the entire line that contains this tag. Shorthand will not type any line that contains thistag. A line is defined as a string of characters that ends with a carriage return. This tag is usefulin conjunction with the {@INPUT} tags for removing blank lines from the final output.

    ExampleThis line will be typed out.This line will not be typed out{@DELETELINE}.

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 56

    @INPUT Tag

    Syntax{@INPUT prompt}{@INPUT(var) prompt}

    DescriptionDisplays a text input dialog box to the user. Shorthand will pause and display a dialog box toaccept text input whenever this tag is encountered. The prompt will appear at the top of thedialog box to remind the user what needs to be entered. var is the name of an optional variableand is limited to alphanumeric characters ('A'..'Z', '0'..'9', '_') and must not exceed 16 characters inlength. If var is present, Shorthand will replace all instances of the string "{var}" with the userinput.

    ExampleName: {@INPUT(name) Please enter your name}Height: {@INPUT(height) Please enter your height}Weight {@INPUT Please enter your weight}Summary: {name} is {height} tall.

    See Also{@INPUT} with Pick Lists

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 57

    @INPUT Tag With Pick Lists

    Syntax{@INPUT prompt @SINGLE @SEP=separator_string item_list}{@INPUT(var) prompt @SINGLE @SEP=separator_string item_list}

    DescriptionDisplays a Pick List Input dialog box to the user. Shorthand will pause and display a dialog boxcontaining a pick list whenever this tag is encountered in the text to type box. The prompt willappear at the top of the dialog box to remind the user what needs to be entered.

    var is the name of an optional variable and is limited to alphanumeric characters ('A'..'Z', '0'..'9','_') and must not exceed 16 characters in length. If var is present, Shorthand will replace allinstances of the string "{var}" with the user input.

    @SINGLE is an optional qualifier; if @SINGLE is present, the user may select only one item fromthe pick list. If @SINGLE is omitted, the user can select more than one item from the pick list; theselected pick list items will be separated by separator_string. The separator_string caninclude any Shorthand tag such as {@KEY Enter}. If @SEP is not specified, the defaultseparator string is a comma.

    item_list specifies the strings that are to appear in the pick list. Each item must appear on aseparate line. The entire string is displayed in the pick list; however if an {@REM caption} tag ispresent in a pick list item, the caption is displayed instead.

    ExamplesExample #1: A pick list that allows only a single selection.

    {@INPUT Select only one color @SINGLEredgreenblue}

    Example #2: A pick list that allows multiple selections; the selected items will be separated bycommas.

    {@INPUT Select one or more colors @SEP=, redgreenblue}

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 58

    Example #3: A pick list that uses @REM tags to customize the displayed items. The user will seea list with the items color of an apple, color of grass, color of the sky instead of red, greenand blue.

    {@INPUT Select only one color @SINGLE{@REM color of an apple}red{@REM color of grass}green{@REM color of the sky}blue}

    Example #4: A pick list with a variable name

    {@INPUT(color) Select one or more colorsredgreenblue}You selected: {color}

    Example #5: A pick list that allows multiple selections; the selected items will appear in separatelines.

    {@INPUT Select one or more colors @SEP={@KEY Enter}redgreenblue}

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 59

    @INPUTDATE Tag

    Syntax{@INPUTDATE prompt}{@INPUTDATE(var) prompt}

    DescriptionDisplays a Date Input dialog box. Shorthand will pause and display a dialog box to accept a datewhenever this tag is encountered in the text to type box.

    The prompt will appear at the top of the dialog box to remind the user what needs to be entered.

    var is the name of an optional variable and is limited to alphanumeric characters ('A'..'Z', '0'..'9','_') and must not exceed 16 characters in length. If var is present, Shorthand will replace allinstances of the string "{var}" with the user input.

    ExampleDate of Birth: {@INPUTDATE Please enter your birthday}

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC Page 60

    @INPUTFILE Tag

    Syntax{@INPUTFILE pathname}{@INPUTFILE(var) pathname}

    DescriptionLoads and inserts a Text File. Shorthand will replace this tag with the contents of the filespecified by pathname. The file must be a standard text file and may contain Shorthand tags.pathname should contain the complete directory (path) and filename of the text file to insert. Ifno path is specified, Shorthand attempts to load the file from the directory where the Shorthanddictionary (.SPF) file resides. If Shorthand could not find the file, the following line will be insertedin your text: "{COULD NOT READ INPUT FILE: pathname}"

    The {@INPUTFILE} tag is useful for keeping large amounts of text in a file separate from theShorthand dictionary (.SPF) file; this saves memory and results in faster loading of Shorthanddictionaries. The {@INPUTFILE} tag is also useful for embedding multiline text in the item_list ofthe {@INPUT} tag.

    var is the name of an optional variable and is limited to alphanumeric characters ('A'..'Z', '0'..'9','_') and must not exceed 16 characters in length. If var is present, Shorthand will replace allinstances of the string "{var}" with the contents of the file specified by pathname.

    Warning: Since inserted files may themselves contain other {@INPUTFILE} tags, youshould watch out for the possibility of circular references in which one file inserts asecond file which inserts the first file again. Shorthand tries to catch this situation bylimiting the number of {@INPUTFILE} tags that may be processed.

    ExamplesExample #1: Insert the file "version.txt" which resides in the same directory as theShorthand dictionary (SPF) file:

    The current version of Shorthand is Version {@INPUTFILE version.txt}

    Example #2: Insert a file according to what the user selects from a picklist. male-report.txt andfemale-report.txt may themselves contain @INPUT tags.

    {@INPUT Select patient's gender{@REM male}{@INPUTFILE male-report.txt}{@REM female}{@INPUTFILE female-report.txt}}

    See Also{@INPUT}

  • Shorthand 8.51 Copyright 2001 OfficeSoft LLC