Ronn/FileReader/FileReader.Doc 06-Dec-93 FILEREADER V1.1 =============== CONTENTS: ========= Section Title ------- ----- 1 . . . . Preface 2 . . . . OverView 2.1 . . . . Introduction 2.2 . . . . Purpose 3 . . . . Getting Started 3.1 . . . . Requirements 3.2 . . . . OverView of installation process 3.3 . . . . Terms and Terminology 3.4 . . . . Detailed installation instructions 3.4.1 . . . . Installing Arp 3.4.2 . . . . Moving FileReader and Substitution.dat files 4 . . . . Running FileReader 4.1 . . . . Running FileReader from the Workbench 4.2 . . . . Running FileReader from the CLI 5 . . . . Correcting Pronunciation of words 5.1 . . . . Tips on forcing correct pronunciation 6 . . . . Controlling default FileReader Settings 6.1 . . . . Setting Control Panel location and size 6.2 . . . . Setting Text Window location and size 6.3 . . . . Setting speed of Filereader 6.4 . . . . Passing the Filename to FileReader automatically. 6.5 . . . . Using Alternate Substitution Files 6.6 . . . . Running FileReader in background mode 7 . . . . Getting Help for FileReader 8 . . . . Summary of CLI and tooltypes options 9 . . . . Release Notes 10. . . . Support/Feedback ================= == 1 - PREFACE == ================= FileReader is a program which will read a text file out loud. The program allows the user to skip around in the file using the common VCR controls of FastForward and Rewind. In addition the user has the ability to pause and restart the program using the Stop and Play functions. FileReader also includes a word or phrase replacement facility that allows the user to correct the pronunciation of various words and phrases that the Amiga's text to speech conversion routines would otherwise mispronounce. ================== == 2 - OVERVIEW == ================== 2.1 - INTRODUCTION: =================== We live in the information age. All around us are multitudes of information. Telephones, television, radio, magazines and newspapers; the list is endless. Yet in spite of all of this information, the trend continues. New television stations are created, and newspapers, magazines and communications equipment continue to proliferate. This rapid increase in information technology has surpassed mans ability to deal with all of this information. There simply is not enough time to absorb this information. Computers have been promoted by many as the solution to this problem but, in truth they have complicated the issue by increasing the range and amount of information available. While computers have increased the amount of information available they have also added tools for handling this information. One tool was introduced to the general public in late 1985 with the Commodore Amiga computer. This tool was the ability to convert text to audible speech. While this may not appear to be a significant tool, it does have useful purposes. Two obvious uses for this capability are to make information available to the illiterate and to help teach people how to read. Another less obvious use for this technology is that it allows people to absorb information without dedicating time for that purpose. In other words people could have a text file read to them while they are working on something else. 2.2 - PURPOSE: ============== The system described above has some short comings which limit its usefulness for the purpose of reading information aloud. The FileReader program described in this documentation was designed to address some of the short comings of the Amiga's text to speech conversion and enhance its suitability for the purpose of reading information to the user. This program achieves this goal with the following: A) VCR-Like controls allow the user to "Rewind", "Stop", "Play", and "Fast Forward" through a text file. B) Graphical user interface with common functions for ease of use. C) Correct pronunciation of numbers. Without FileReader, the text to speech conversion would pronounce 1.0 and $20 as "one zero" and "dollar two zero" respectively. FileReader forces the pronunciation of these to "one point zero" and "twenty dollars" as most people would pronounce them. D) User definable word replacement list allows the user to force the correct pronunciation of up to 10,000 commonly mispronounced words & phrases. E) Location counter display allows the user to keep track of where they are in the file that is being read to them. F) The user can control the speed of recitation through an AmigaDos tooltypes setting or CLI option. G) The user can set the preferred control panel and Text display location and size through an AmigaDos tooltypes setting or CLI options. H) Full Tooltypes and Project Icon support. NOTE: Project Icons are not supported under V1.0 I) Background mode allowing FileReader to be used as part of a MultiMedia presentation. ========================= == 3 - GETTING STARTED == ========================= 3.1 - REQUIREMENTS: =================== The system requirements for running this program are as follows. · Amiga 500, 1000, 2000, 2500, or 3000 series computer. · Workbench 1.3 or later (Workbench 2.0 Compatible). · 1 Meg memory. 3.2 - OVERVIEW OF INSTALLATION PROCESS: ======================================= This section presents and overview of the process of installing and running the FileReader program. If you are an experienced AmigaDos user you may follow these instructions to install the program. Otherwise, you should read this section, then follow the detailed installation instructions to install the program. In general the installation consists of 3 steps. 1) Install the ARP Library in the LIBS: directory of your system boot disk by double clicking on the INSTALL_ARP icon. 2) Move the files "FileReader" and "Substitution.Dat" to your preferred drawer by selecting both Icons and dragging them into the drawer where you want to place them. The actual location does not matter as long as both files are in the same drawer and the Arp library has been installed. (NOTE: you also have the option of leaving them on the distribution diskette and running FileReader from there.) 3) Run the FileReader program by double clicking on its icon. Select the play [>] button. Your will be presented with a file requester where you will select the text file that you wish to read and then select [OK]. 3.3 - TERMS AND TERMINOLOGY: ============================ The following terms and terminology should be clarified before proceeding to the detailed installation instructions. CLICK or SELECT - This operation consists of the following actions: 1) Position the mouse pointer over the object to be selected. 2) Press the left (selection) mouse button once. EXTENDED SELECTION - This operation allows more than one Icon to be manipulated at a time. This consists of the following steps: 1) Position the mouse point over the 1st object to be selected. 2) Press the left (selection) mouse button once. 3) Press and hold the either of the keys on the keyboard. 4) Position the mouse pointer over the next object to be selected. 5) Press the selection button once. This will add that icon to the group. If you continue clicking on Icons while holding the key they will be added to the group. To remove an Icon from the group, hold the key and click on the Icon a second time. 6) When you have all objects selected, release the key and then perform the action on the selected icons. For example to drag them all to a different drawer; click and hold on one of the Icons selected and drag it to the destination drawer. DRAG - This operation consists of the following steps: 1) Position the mouse pointer over the object to be dragged. 2) Press and hold the left (selection) mouse button. 3) Move the mouse to drag the object to the new location. 4) Release the selection button when you have the object over the desired location. DOUBLE CLICK - This consists of the following steps: 1) Position the mouse pointer over the desired object. 2) Press the selection button twice in rapid succession. MENU SELECTION - This consists of the following actions: 1) Press and hold the Right (Menu) mouse button. 2) Move the mouse pointer to the title bar at the top of the screen. The menu choices will pop down from the title bar. Moving the mouse over each option will highlight the choice. 3) Release the right (Menu) mouse button when you have highlighted your desired choice. If you do not wish to make a selection, move the mouse pointer off all menu options and release the menu button. KEYPRESSES - The following symbols are used to represent certain key presses: - This indicates to press the return key ... - This indicates one of the Function keys labeled F1...F10 along the top of the keyboard. - This notation indicates a space. - This indicates to press and hold the Control key and then press the key following the "-" (in this case the "X" key). 2) To delete a file from the list above enter the command: DELETE {file to delete} 3) Repeat steps 1 & 2 until you have cleared enough space on the system boot disk. When you have cleared enough space, exit the shell with the command ENDCLI NOTE: Under WorkBench 2.0 or later simply select "Show all files" and drag these files into the trashcan. Select the trashcan and select "empty trash" from the menu. To install the Arp Library, double click on the INSTALL_ARP icon. This will run an AmigaDos script file that will check for the Arp Library in the LIBS: drawer. If Arp is already installed the installation procedure will respond with "Arp Library is already installed..." "Press to exit:" otherwise the following messages will be displayed. "Copying Arp library to RAM:..." "Copying Arp library to LIBS:..." "Removing Arp library from RAM:..." "Arp library installation complete." "Press to exit:" NOTE: This procedure only installs the ARP library. This is not a complete Arp installation! 3.4.2 - MOVING FILEREADER and SUBSTITUTION.DAT FILES: ===================================================== The FileReader program need not be moved. It is perfectly acceptable to run the program from the distribution diskette once the Arp library is installed. The following procedures are only needed if you wish to relocate FileReader. The relocation procedure is fairly straightforward as long as both the "FileReader" and "Substitution.dat" files remain in the same drawer. To move the program, use extended selection to select the FileReader and Substitution.dat files. Drag both Icons over the drawer (or disk) icon where you want the program installed. NOTE: If you are using a single disk drive system then you should drag the files into the RAM: disk. Then drag them from the RAM: disk into the final destination. This will minimize disk swapping. ============================ == 4 - RUNNING FILEREADER == ============================ 4.1 - RUNNING FILEREADER FROM THE WORKBENCH: ============================================ To run FileReader from the workbench, follow the steps below: 1) Double Click on the FileReader Icon. 2) Click on the Play Button [>]. You will be presented with a file requester. 3) Use the FileRequester to select the file you want to read. 4) Click on the [OK] button of the file requester. 5) Adjust the volume as desired. 6) Use Rewind [<<] to backup, FastForward [>>] to skip ahead and Stop [||] to pause the program. To exit the program click on the close gadget in the upper left corner of the control panel window. 7) See "Summary of Tooltypes" for more information. 4.2 - RUNNING FILEREADER FROM THE CLI: ====================================== To run FileReader from the CLI (or shell), follow the steps below: 1) Enter the shell by double clicking on the System boot disk icon, then double click on the shell icon. 2) Change the current directory to the location of the FileReader program with the command below: CD {location of FileReader} 3) Type the following command: FILEREADER 4) Click on the Play Button [>]. You will be presented with a file requester. 5) Use the FileRequester to select the file you want to read. 6) Click on the [OK] button of the file requester. 7) Adjust the volume as desired. 8) Use Rewind [<<] to backup, FastForward [>>] to skip ahead and Stop [||] to pause the program. To exit the program click on the close gadget in the upper left corner of the control panel window. 9) See "Summary of CLI options" for more information. =========================================== == 5 - CORRECTING PRONUNCIATION OF WORDS == =========================================== One of the problems with the Amiga's text to speech routines is that it frequently mispronounces some words. FileReader has a search and replace facility to locate these problem words and replace them with a different spelling so that they will be pronounced correctly. The user can control this replacement feature by editing the list contained in the file "SUBSTITUTION.DAT". This file can be edited with any standard editor like "Micro emacs" or "ED". The substitution file contains a list of search phrases and replacement phrases. The "search" phrases are located on the odd lines (1,3,5,7...) and the "replacement" phrases are located on the even lines (2,4,6,8...). In order to make the list easier to maintain it is suggested that search words are maintained in UPPERCASE and replacement words in lowercase. The following example will attempt to demonstrate the operation of the system. If the substitution file (SUBSTITUTION.DAT) contains: ASCII ahskee ALLOW ahlou every occurrence of "ASCII" will be replaced with "ahskee" (for pronunciation purposes), and all occurrences of "ALLOW" will be replaced with "ahlou". This replacement is not limited to just the uppercase occurrences of these words but also includes any mixture of different cases throughout the words. For example the words RED, red, Red, reD, ReD, REd, and rED are all identical for substitution purposes. Another important item is that replacements are not recursive. In other words, once a word (or phrase) has been replaced it is no longer considered for replacement. For example, if the substitution list is as follows: READ --> red RED --> rehd and the sentence to be spoken is: "I READ REDBOOK" then FileReader will create the following sentence for pronunciation (substitutions are shown in lowercase): "I red rehdBOOK" Notice that "READ" translated to "RED" and not "REHD". Another point of interest is that the word "RED" in the word "REDBOOK" was also translated. These points highlight some of the reasons behind the guidelines described below: 1) The substitution list should be in order of Longest words (or phrases) to shortest. 2) Make words as unique as possible. This may mean that small words may need spaces to avoid replacing in unwanted positions of larger words. For example, "AL" should be "AL" or else words like "ALLOW" will be mispronounced. 3) Search words should be maintained in uppercase and replacements in lower case. This makes it easier to maintain the list by identifying which words go together. 4) Remember that substitutions only occur once. For example don't make a substitution of "READ" with "RED" and expect a different substitution of "RED" with "REHD" to correct the pronunciation. This will not work since substitutions are not recursive. 5) Remember that some words are pronounced differently in different situations. For example the present and past tense of the word "READ". In present tense this word is pronounced "REED" and past tense it is pronounced "RED". If you correct it for one situation it will be wrong for another situation. In situations like these, the only thing you can do is to look for partial phrases like "HAVE READ" or "WILL READ" that can indicate the correct pronunciation. 5.1 - TIPS ON FORCING CORRECT PRONUNCIATION: ============================================= If you followed the discussions in the "correcting pronunciation" section you realize that FileReader corrects pronunciation of words by spelling them incorrectly. The purpose of this section is to show some methods which can be used to get the correct pronunciation. Sometimes the Amiga incorrectly pronounces the long "E" sound as in "BEE". This can easily be corrected by spelling the word with "EE" in the appropriate place. For example (NOTE: Substitutions shown in UPPERCASE): previously --> prEEvEEously Another common problem is the incorrect pronunciation of the long "A" sound as in "APE". This can be corrected by using the "AY" spelling in the appropriate position. For example: apex --> AYpex Another common problem area is the long "O" sound as in "BOAT". This can often be fixed by spelling the word with "OA" in the corresponding position. For example: synchronized --> synkrOAnized A problem which is rather difficult to describe and hard to correct is the "OO" sound as in "BOO" or "DO". This correction typically requires a great deal of experimentation. The various combinations can easily be tested using the say command. This can sometimes be corrected with the "OW", "OO", "OU" or the addition of the hyphen "-" in an appropriate position. For example: vancouver --> vancOOver Other somewhat difficult corrections which require a fair amount of experimentation are the short vowel sounds. This includes the short "A" sound as in "BAT", the short "E" sound as in "BET", and the short "I" sound as in "BIT". Most of these simply need an "H" after the vowel to create the short vowel sounds. In some cases the short sound can be created by using a hyphen in the word (or a combination of the above techniques). For example: fixer --> fIHxer nasa --> nAHsa novice --> nOHvis merry --> mEHrry ability --> A-bility fixes --> fIx-es There are some cases where none of the above guidelines apply or work. These cases can only be handled through experimentation using the say program and compromising your desires. ================================================= == 6 - CONTROLLING DEFAULT FILEREADER SETTINGS == ================================================= When working in a windowed environment it is common for more than one program to attempt to use the same screen location for their display. It is quite easy for the user to grab the FileReader control panel or text window by the drag bar and move it out of the way. However, if FileReader is frequently used simultaneously with a program that uses the same screen location, it becomes a nuisance to move the window every time. FileReader provides several methods of controlling the window locations and sizes. 6.1 - SETTING CONTROL PANEL LOCATION AND SIZE: ============================================== FileReader provides two methods for moving the control panel window to a new location when the program is run. The first method is used when the program is run from the CLI environment. This is controlled through the following syntax: FILEREADER CONTROL=LeftEdge, TopEdge, Width, Height where: LeftEdge = Location of the Left side of the control panel window. TopEdge = Location of the Top side of the control panel window. Width = Width of the control panel window. Height = Height of the control panel window. default: LeftEdge = 0 TopEdge = 10 Width = 140 Height = 35 The second method is used when the program is run from the Workbench, by double clicking on the FileReader icon. This is controlled by setting the "CONTROL" tooltypes setting using the following procedure: 1) Select the FileReader icon. 2) Select "INFO" from the workbench menu. 3) When the info window opens, click on the [ADD] button beside the tooltypes box. 4) Enter "CONTROL=LeftEdge, TopEdge, Width, Height" where: LeftEdge = Location of the Left side of the control panel. TopEdge = Location of the Top side of the control panel window. Width = Width of the control panel window. Height = Height of the control panel window. default: LeftEdge = 0 TopEdge = 10 Width = 140 Height = 35 NOTE: this is case sensitive 5) Click on the [^] and [v] buttons to verify that there is only one "CONTROL=" statement. Use the [DEL] button to remove any duplicates. 6) When you have the tooltypes set as desired, click on the [SAVE] button. 7) From now on when you start the program by double clicking on the icon, the control panel will appear in the specified location. 6.2 - SETTING TEXT WINDOW LOCATION AND SIZE: ============================================ FileReader provides two methods for setting the text display window location and size when the program is run. The first method is used when the program is run from the CLI environment. This is controlled through the following syntax: FILEREADER TEXT=LeftEdge, TopEdge, Width, Height where: LeftEdge = Location of the Left side of the text display window. TopEdge = Location of the Top side of the text display window. Width = Width of the text display window. Height = Height of the text display window. default: LeftEdge = 0 TopEdge = 45 Width = 640 Height = 155 The second method is used when the program is run from the Workbench, by double clicking on the FileReader icon. This is controlled by setting the "TEXT" tooltypes setting using the following procedure: 1) Select the FileReader icon. 2) Select "INFO" from the workbench menu. 3) When the info window opens, click on the [ADD] button beside the tooltypes box. 4) Enter "TEXT=LeftEdge, TopEdge, Width, Height" where: LeftEdge = Location of the Left side of the text display window. TopEdge = Location of the Top side of the text display window. Width = Width of the text display window. Height = Height of the text display window. default: LeftEdge = 0 TopEdge = 45 Width = 640 Height = 155 NOTE: this is case sensitive 5) Click on the [^] and [v] buttons to verify that there is only one "TEXT=" statement. Use the [DEL] button to remove any duplicates. 6) When you have the tooltypes set as desired, click on the [SAVE] button. 7) From now on when you start the program by double clicking on the icon, the text display window will appear in the specified location. 6.3 - SETTING SPEED OF FILEREADER: ================================== Some people may find it difficult to keep up with the reading pace of FileReader while others may find this pace to slow. In addition, as a person becomes accustom to listening to FileReader, they may find that they can handle a faster pace. Since people's tastes may vary, FileReader provides two methods for controlling the reading pace. The first method is used when the program is run from the CLI using the following syntax: FILEREADER SPEED={rate} where: rate = speed in the range 30-400 default: rate = 220 The second method is used when the program is run from the workbench by double clicking on the FileReader icon. This is controlled by setting the "SPEED=" tooltypes setting using the following procedure: 1) Select the FileReader icon. 2) Select "INFO" from the workbench menu. 3) When the info window opens, click on the [ADD] button beside the tooltypes box. 4) Enter "SPEED=rate" where: rate = speed in the range 30-400 default: rate = 220 NOTE: this is case sensitive 5) Click on the [^] and [v] buttons to verify that there is only one "SPEED=" statement. Use the [DEL] button to remove any duplicates. 6) When you have the tooltypes set as desired, click on the [SAVE] button. 7) From now on when you start the program by double clicking on the icon, the program will read at the specified rate. 6.4 - PASSING THE FILENAME TO FILEREADER AUTOMATICALLY: ======================================================= There are several ways to pass the filename to be read directly to FileReader so that it will start reading immediately. The first method is used when the program is run from the CLI using the following syntax: FILEREADER DRIVE:DRAWER/FILENAME where: DRIVE: = The disk drive where the file to be read is located (ex: df0:, dh0:, ram:) DRAWER = The drawer or subdrawers where the file to be read is located (ex: CompuServe/, LogFiles/JoesBBS/). FILENAME = The name of the file to be read. (ex: Session_10-Mar-91.txt) example: DF0:LogFiles/JoesBBS/Session_10-Mar-91.txt NOTE: If your current default is not set to the directory containing the substitution.dat file, you will also need to specify the substitution file location using the SUBS= keyword. The second method of passing the filename to be read to FileReader is when the program is run from the workbench. This method involves setting the default tool of a text file (with icon) to FileReader. This can be done by the following procedure: 1) Select the icon of the TEXT file. 2) Select "INFO" from the workbench menu. 3) When the info window opens, click in the "DEFAULT TOOL" field. 4) Erase the contents of this field and replace with the following: DRIVE:DRAWER/FILEREADER where: DRIVE: = The disk drive where the FileReader program is located. (ex: df0:, dh0:, ram:) DRAWER = The drawer or subdrawers where the FileReader program is located (ex: utilities/, utilities/filereader/). example: DF0:Utilities/FileReader/FileReader 6) When you have the default tool set as desired, click on the [SAVE] button. 7) From now on when you double click on the icon for the text file it will start the FileReader program and load this file. The third option is to extended select the FileReader icon and the icon of the text file to be read, then double click the text files icon. This is described in the following procedure: 1) Click on the FileReader icon. 2) Hold down the key. 3) Double Click on the icon of the Text File to be read. (Note: This file must be text only, it can't be a word processing format file.) NOTE: Project Icons are not supported under FileReader V1.0 6.5 - USING ALTERNATE SUBSTITUTION FILES: ========================================= Whenever FileReader is run from the CLI and your current directory is not the same as the directory containing the substitution file, you must specify the substitution file location and name. In addition in some cases it may be desireable to have multiple substitution files which are used depending on the type of document that is being read. Substitution Files can only be specified using the following CLI syntax: FILEREADER SUBS=DRIVE:DRAWER/FILENAME where: DRIVE: = The disk drive where the substitution file is located. (ex: df0:, dh0:, ram:) DRAWER = The drawer or subdrawers where the substitution file is located (ex: utilities/, utilities/filereader/). FILENAME = The filename of the substitution file. (ex: Substitution.dat) example: DF0:Utilities/FileReader/Substitution.dat 6.6 - RUNNING FILEREADER IN BACKGROUND MODE: ============================================ FileReader offers the option of running in the background without opening any windows. This mode of operation is useful if you are trying to run FileReader in conjunction with a MultiMedia presentation and you do not want to have it open any windows. This option is only available from the CLI and requires that the filename of the file to be read is passed on the command line as well (since there will be no way to open the file). The background mode can be activated by the following syntax on the command line: FILEREADER NOWINDOWS Filename where: Filename --> is the complete path and Filename of the file to be read. NOTE: If your current default is not set to the directory containing the substitution.dat file, you will also need to specify the substitution file location using the SUBS= keyword. In addition, there is no way to exit the program so as soon as the end of the text file is reached the program exits. This will cause FileReader to recite the file specified without opening any windows. When FileReader reaches the end of the file it will exit. Another variation on this scheme is the ability for FileReader to selectively disable one or the other of the control panel or text display windows. These can be disabled through the NOTEXT and NOCONTROL keywords. The examples below show the syntax for these options: FILEREADER NOTEXT --> This syntax starts FileReader with a control panel but no text display window. FILEREADER NOCONTROL Filename --> This syntax starts FileReader with a text display window but no Control Panel. NOTE: When you do not have any control panel there is no way to start FileReader reciting a file so you must pass the filename on the command line. In addition, there is no way to exit the program so as soon as the end of the text file is reached the program exits. 7 - GETTING HELP FOR FILEREADER: ================================ If you don't remember the command line or tooltypes settings and the documentation is not close at hand, help can be gotten by the following steps: 1) Enter the shell by double clicking on the System boot disk icon, then double click on the shell icon. 2) Change the current directory to the location of the FileReader program with the command below: CD {location of FileReader} 3) Type the following command: FILEREADER ? 4) FileReader will give a short description and list the CLI parameters. Note that those options which are supported as tooltypes are the identical syntax. 8 - SUMMARY OF CLI AND TOOLTYPES OPTIONS: ========================================= This section presents a summarized list of the options which may be used when running FileReader. Some of these options where designed specifically so that FileReader can be used as part of a multimedia presentation without intruding on the presentation by popping up unwanted windows or icons. ---------------------------------------------------------------------------- Parameter: CONTROL - This option is used to set the location of the control panel window. This option will function as either a CLI parameter or a Tooltypes parameter. Syntax: CONTROL=TopEdge,LeftEdge,Width,Height where: LeftEdge = Location of the Left side of the control panel window. TopEdge = Location of the Top side of the control panel window. Width = Width of the control panel window. Height = Height of the control panel window. Default: LeftEdge = 0 TopEdge = 10 Width = 140 Height = 35 Examples: FileReader control=0,0,150,35 {CLI parameter} CONTROL=0,0,150,35 {Workbench ToolType Setting} These settings place the control panel in the upper left corner of the workbench screen at the normal height and width. Note that the Workbench Tooltypes setting is in uppercase (it is case sensitive). See Also: 6.1 - SETTING CONTROL PANEL LOCATION AND SIZE ---------------------------------------------------------------------------- Parameter: TEXT - This option is used to set the location of the text display window. This option will function as either a CLI parameter or a tooltypes parameter. Syntax: TEXT=LeftEdge, TopEdge, Width, Height where: LeftEdge = Location of the Left side of the text display window. TopEdge = Location of the Top side of the text display window. Width = Width of the text display window. Height = Height of the text display window. Default: LeftEdge = 0 TopEdge = 45 Width = 640 Height = 155 Examples: FileReader text=0,0,640,200 {CLI parameter} CONTROL=0,0,640,200 {Workbench ToolType Setting} These settings place the text display window in the upper left corner of the workbench screen and set the dimensions such that the window would occupy the entire workbench screen in non-interlaced mode without overscan. Note that the Workbench Tooltypes setting is in uppercase (it is case sensitive). See Also: 6.2 - SETTING TEXT WINDOW LOCATION AND SIZE ---------------------------------------------------------------------------- Parameter: SPEED - This option is used to control the reading rate of FileReader. Syntax: SPEED=rate where: rate = A speed in the range 30-400 Default: rate = 220 Examples: FileReader SPEED=300 {CLI Parameter} SPEED=300 {Workbench Tooltypes setting} These settings make FileReader recite text at 300 words per minute. Note that the Workbench tooltypes setting is in uppercase (it is case sensitive). See Also: 6.3 - SETTING SPEED OF FILEREADER ---------------------------------------------------------------------------- Parameter: SUBS - This option allows different Substitution files to be used or allows the substitution file location to be specified when the current directory does not contain the substitution file. This is only a CLI option. Syntax: SUBS=drive:drawer/filename where: drive: = The disk drive where the substitution file is located. (ex: df0:, dh0:, ram:) drawer = The drawer or subdrawers where the substitution file is located (ex: utilities/, utilities/filereader/). filename = The filename of the substitution file. (ex: Substitution.dat) Default: drive: = current drive if started from CLI or drive containing FileReader if started from workbench. drawer = current drawer if started from CLI or drawer containing FileReader if started from workbench. filename = Substitution.dat Examples: FileReader subs=DF0:Utilities/FileReader/TechSubstitution.dat This command line example above runs filereader using the substitution file "TechSubstitution.dat" in the drawer "Utilities/FileReader" on the floppy disk in drive DF0: See Also: 6.5 - USING ALTERNATE SUBSTITUTION FILES ---------------------------------------------------------------------------- Parameter: FILENAME - This option allows FileReader to begin reading a file as soon as the program is run, without requiring further intervention by the user. This is available from the CLI by passing the path and filename on the command line or from the workbench by extended selection or by setting the default tool of the text file to point at filereader. Syntax: DRIVE:PATH/FILENAME {from CLI only} where: DRIVE: = The disk drive where the file to be read is located. (ex: df0:, dh0:, ram:) DRAWER = The drawer or subdrawers where the file to be read is located (ex: CompuServe/, LogFiles/JoesBBS/). FILENAME = The name of the file to be read. (ex: Session_10-Mar-91.txt) NOTE: If your current default is not set to the directory containing the substitution.dat file, you will also need to specify the substitution file location using the SUBS= keyword. Default: NONE Examples: FileReader DF0:LogFiles/JoesBBS/Session_10-Mar-91.txt {CLI} The CLI command shown above loads FileReader and immediately begins reading the file Session_10-Mar-91.txt in the directory Logfiles/JoesBBS on the floppy disk in drive DF0: See Also: 6.4 - PASSING THE FILENAME TO FILEREADER AUTOMATICALLY ---------------------------------------------------------------------------- Parameter: NOWINDOWS - This option starts FileReader in the background mode with no windows opened. This parameter is only valid when FileReader is started from the CLI. The filename of the text file to be read should be passed on the command line as well since there will be no way to start the program reading a text file. Syntax: NOWINDOWS Default: NONE Examples: FileReader nowindows FileReader.doc {CLI keyword} This example starts filereader in background mode reciting the file FileReader.doc. When FileReader reaches the end of the file the program will exit. See Also: 6.6 - RUNNING FILEREADER IN BACKGROUND MODE ---------------------------------------------------------------------------- Parameter: NOCONTROL - This option starts FileReader in the background mode with no control panel opened. This parameter is only valid when FileReader is started from the CLI. The filename of the text file to be read should be passed on the command line as well since there will be no way to start the program reading a text file. Syntax: NOCONTROL Default: NONE Examples: FileReader nocontrol FileReader.doc {CLI keyword} This example starts filereader in background mode with only the text display window showing. FileReader will begin reciting the file FileReader.doc. When FileReader reaches the end of the file the program will exit. See Also: 6.6 - RUNNING FILEREADER IN BACKGROUND MODE ---------------------------------------------------------------------------- Parameter: NOTEXT - This option starts FileReader in the background mode with no text display window opened. This parameter is only valid when FileReader is started from the CLI. Syntax: NOTEXT Default: NONE Examples: FileReader notext {CLI keyword} This example starts filereader in background mode with only the control panel window showing. See Also: 6.6 - RUNNING FILEREADER IN BACKGROUND MODE ======================= == 9 - RELEASE NOTES == ======================= RELEASE: V1.0 - May 1991 - First Official release V1.1 - 12-Sep-1991 - 2nd Release - Changed default for TextWindow from NEWCON to CON since NEWCON disappeared under AmigaDos 2.0. - Changed Gadget draw colors to provide correct appearance under Default AmigaDos 2.0 Color Scheme. - Slowed down default reading speed from 260 to 220. Probably still too fast for many people. - Minor Documentation changes. - Added Tooltypes to Icon by default so that it is easier for people to just change what they want. =========================== == 10 - SUPPORT/FEEDBACK == =========================== Support questions and feedback can be channeled to _____________ |`:::::::::::'| ,--------'\ `-:::::-' /`--------. |####| \ / \ / |####| |####| \/\___/\/ |#[]#| Ronn Black |####| |'| _|_ |####| Black Tie Software |####| | | |___||####| 4474 Valley Quail Blvd |####| |*| | ||####| Westerville, OH 43081 |####| | | `---'|####| |####| | | |####| Phone: (614) 891-3721 |####| ` ' |####| Internet: ronn@btsoft.cmhnet.org |####| V |####| |####| |####| |####`---------------------'####| |###############################| |###############################| |####,-----------------.########| |####|:+---+:::::::::::|########| |####|:|###|:::::::::::|########| |####|:|###|:::::::::::|########| |####|:|###|:::::::::::|########| |####|:|###|:::::::::::|########| \###|:+---+:::::::::::|########| `-'`--------------------------' Also Available: ProWrite Tools: $25 · Add table of contents and index generation to ProWrite. · Completely Automatic Operation. · Features Progress bars and status windows. Custom programming, animation & clipart: · Reasonable rates. · Specializing in Multi-Media Productions Comming Soon: Michaels Math Quiz: $30 · Racing game, Noahs Ark, Space Shuttle, Picture Puzzle · Practice any type of math with any game. · High quality animation & graphics Structured Clipart Collection · Art Expression, Adobe Illustrator, DR2D, EPS formats · High quality, very detailed. · Full color. · For use with PageStream, Art Expression, Final Writer, ProVector, Art Expression, Adobe Illustrator, Aldus Freehand, Correl Draw.