home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / handicap / ralph21.zip / RALPH.DOC < prev    next >
Text File  |  1990-03-08  |  14KB  |  299 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                         RALPH THE READER
  8.                           DOCUMENTATION
  9.                            Version 2.1
  10.  
  11.  
  12.                            March, 1990
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                   Copyright (c) 1988 1989 1990
  19.                          by Kansys, Inc.
  20.                         1016 Ohio Street
  21.                        Lawrence, KS  66044
  22.  
  23.  
  24.                    Telephone:  (913) 843-0351
  25.  
  26.  
  27.  
  28.  
  29.      RALPH THE READER is a shareware program, written and
  30. distributed by Kansys, Inc.  If RALPH is valuable to you, and you
  31. find yourself using it regularly, please honor the shareware
  32. concept by paying for the program.  The cost is only $10.00.  You
  33. can find information on making this payment at the end of this
  34. file.  
  35.  
  36.      We hope that you enjoy RALPH THE READER as much as we do. 
  37. Thanks for taking the time to download the program and trying it
  38. out.  Please feel free to share it with others.
  39.  
  40. David Andrews
  41. Vice-President of Sales and Marketing
  42. Kansys, Inc.
  43.  
  44.  
  45.                            FEATURES
  46.  
  47.  
  48.  
  49.      RALPH THE READER is what is generally called a "text file
  50. reading program."  However, there is one twist.  In addition to
  51. reading standard ASCII text files, RALPH will also directly read
  52. WordPerfect Version 4.2 and 5.0 and Wordstar Professional
  53. Versions 4.0 and 5.x files.  While not all attributes such as
  54. boldfacing and underlining will be shown, RALPH will still
  55. display each file type on-screen, allowing you to read, search
  56. and/or jump around the file at will.  
  57.  
  58.      RALPH THE READER will allow you to do the following things:
  59. display an ASCII text file, WordPerfect or Wordstar file to your
  60. computer's monitor and/or speech synthesizer a screen at a time,
  61. jump to the beginning or end of any file immediately,
  62. jump to any line number within a file,
  63. read in a continuous or "nonstop" mode,
  64. search forward or backward in a file for any text string,
  65. search forward or backward for the beginning of a paragraph, and
  66. search forward or backward for control characters.
  67.  
  68.      While RALPH THE READER is very easy to use and little
  69. explanation is needed, the following brief documentation should
  70. explain all features.
  71.  
  72.                       STARTING THE PROGRAM
  73.  
  74.      To start RALPH THE READER simply type ralph from the DOS
  75. prompt with the program ralph.exe located on a disk in your
  76. default drive and sub-directory.  However, if RALPH is located on
  77. a drive or sub-directory on your computer's path, it is not
  78. necessary to make that drive and/or sub-directory your default. 
  79. As an added time saver, it is also possible to load the file to
  80. be read at the same time you execute RALPH.  To do so type ralph
  81. a space and the filename of the file to be read.  It is
  82. permissible to use the MS-DOS wildcards, question (?) and star
  83. (*) when specifying files.  Thus it is possible to read multiple
  84. files one after the other or to read a file for which you do not
  85. know the entire name or spelling.  You can also supply RALPH with
  86. full drive and/or path specifications for the data file to be
  87. read.  For example, if RALPH THE READER is in your default drive
  88. or path, you could read this file located in your "docs" sub-
  89. directory by typing the following line and a carriage return,
  90. from the DOS Prompt.  The quotation marks, which are included for
  91. clarity, should not be typed.  "ralph c:\docs\ralph.doc."  The
  92. command "RALPH *.DOC" would allow you to read all the files
  93. ending with the .doc extension located in the sub-directory into
  94. which you are presently logged.  If RALPH THE READER cannot find
  95. the file you specify, it will notify you and prompt for another
  96. filename.
  97.  
  98.      RALPH THE READER will use all available computer memory to
  99. hold the file currently being read.  Consequently, it is possible
  100. to read very large files with RALPH.  The percentage of memory
  101. being used is displayed on the top line of the "Control Panel." 
  102. If the file is larger than available memory, RALPH will load as
  103. much as possible and tell you that 100 percent has been used.  
  104.  
  105.      You may wish to rename RALPH to something shorter and/or
  106. easier to type.  This could be "RTR" for RALPH THE READER or
  107. anything you choose.  Consult your DOS manual for instructions on
  108. renaming a file.  Just be sure that your new name is followed by
  109. a period (.) and the three letter extension (exe).
  110.  
  111.                      MOVEMENT WITHIN A FILE
  112.  
  113.      Once a file has been loaded, RALPH THE READER will
  114. automatically display the first 22 lines of that file.  To see
  115. the next 22 lines, just press the PAGEDOWN key.  You can page
  116. through the file by repeatedly pressing the PAGEDOWN key. 
  117. Conversely, to display the previous 22 lines, just press the
  118. PAGEUP key.  The use of these two keys will allow you to page
  119. forward or backward through any file.
  120.      In addition, there are ways to make larger moves.  A press
  121. of the HOME key will take you to the top of the file and a press
  122. of the END key will take you to the bottom of the file
  123. immediately.  You can jump to any line within a file by pressing
  124. the (j) key and typing the line number desired followed by a
  125. carriage return.  This type of move is also immediate in its
  126. execution.  It is also possible to jump forward or backward to
  127. the beginning of a paragraph with the "J" command.  To jump
  128. forward, enter "JF" and to jump backward, enter "JB."  For these
  129. commands to work properly the text must be single spaced and
  130. paragraphs must be separated by a blank line.  Finally, a press
  131. of the question mark will always show you a list of available
  132. commands once a file has been loaded.
  133.  
  134.                          NONSTOP READING
  135.  
  136.      Starting with Version 2.0, RALPH THE READER supports a
  137. continuous or "nonstop reading" mode.  This mode is invoked with
  138. a press of the letter "n" once a file has been loaded.  RALPH
  139. will then send your speech synthesizer a continuous stream of
  140. data.  This command will make it easy for you to sit back and
  141. read a file without having to press the pagedown key.
  142.  
  143.      For the "n" command to work properly, your screen review
  144. package must support some kind of buffered reading mode or most
  145. of the data will be lost.  Further, once you have initiated
  146. nonstop reading, there is no way to stop it.  The only thing you
  147. can do is to kill speech and wait for the data to silently pass
  148. through.
  149.  
  150.                             SEARCHING
  151.  
  152.      It is possible to search for any string of characters within
  153. a file, once it is loaded into RALPH THE READER.  To search
  154. forward from your present location, press "f."  To search
  155. backward from your present location, press the "b" key.  You will
  156. then be prompted for the search string.  Enter the search string
  157. and press return.  The search process is not case sensitive so
  158. proper capitalization is not important.  The search string can be
  159. up to 72 characters long and any control characters passed
  160. through by DOS can be included.  However, it is not possible to
  161. include a carriage return in the search string as this terminates
  162. the string entry and initiates the search.  Consequently, the
  163. search string must be on one line.  The search string can be
  164. edited with the backspace key.  It is also possible to include
  165. the extended ASCII or graphics characters in a search string. 
  166. Consult your DOS manual for details on typing these characters
  167. from your keyboard.  
  168.  
  169.      If the search is unsuccessful, you will be told, "not
  170. found."  You will then be given the -> RALPH prompt, which means
  171. that he is waiting for any valid command.
  172.  
  173.      It is also possible to repeat a search without re-entering
  174. the string.  Just press "f" or "b" depending on whether you want
  175. to search forward or backward.  Then hit the carriage return key
  176. to repeat the search for the previously entered string.  Once a
  177. string is entered, you can search forward or backward for it at
  178. will.
  179.  
  180.                        EXITING THE PROGRAM
  181.  
  182.      It is possible to terminate the reading of a file at any
  183. time by pressing the escape key, unless you are in the nonstop
  184. reading mode.  In that case, you will have to wait for RALPH to
  185. reach the end of the file.  Once reading has been terminated with
  186. the "Escape" key, you have two options:  exiting the program
  187. completely or reading another file.  To exit, press the return
  188. key and then "y" to exit to DOS.  To read another file, just type
  189. in its name followed by a return.  If you previously used wild
  190. card characters which selected more than one file, you will
  191. automatically be presented with the second and any subsequent
  192. files.  
  193.  
  194.                         THE CONTROL PANEL
  195.  
  196.      RALPH THE READER divides the screen into two sections.  The
  197. top three lines are the control panel and the bottom 22 lines are
  198. used for the display of text.  The first line will give you
  199. information on the file that RALPH is reading including:  file
  200. type and name, number of lines and percentage of computer memory
  201. used.  The second line contains the RALPH prompt, "->" as well as
  202. search strings as they are being entered.  The third line of the
  203. panel normally tells you the line number of the first line being
  204. displayed.  It will also display various prompts throughout the
  205. program.  
  206.  
  207.                           DESIGN GOALS
  208.  
  209.      RALPH THE READER is a MS-DOS program written in C. 
  210. Consequently, it should run on any IBM or compatible computer
  211. using DOS 2.x or 3.x.  Version 1.5 of RALPH THE READER fixed some
  212. display anomalies which prevented the program from running on
  213. certain computers, namely Toshiba laptops.  The program should
  214. now run on any IBM or compatible computer.  As mentioned earlier,
  215. Version 2.0 of RALPH added a continuous reading mode, searches by
  216. paragraph and support for WordPerfect 5.0 and WordStar 5.0 and
  217. 5.5 files.  Version 2.1 fixes a few display bugs that cropped up,
  218. however, the operation of the program is still the same.  If you
  219. use Articvision or Artic Businessvision as your screen reading
  220. software, you will need to turn off Speech Autoclear when using
  221. RALPH.  If you don't, RALPH will not be able to read you all of
  222. each screen as Artic's slow response time in autoclearing speech
  223. will wipe out part of each screen after RALPH updates it.
  224.  
  225.      An important consideration in the design and implementation
  226. of RALPH THE READER was to come up with a program that could be
  227. used equally well by sighted computer users as well as blind
  228. persons using screen review programs and speech synthesizers. 
  229. RALPH strives to combine the advantages of both screen and line
  230. oriented programs.  
  231.  
  232.      Many modern programs write directly to your computer's video
  233. output, bypassing the BIOS.  This makes updating the screen very
  234. fast, however, as those of you who use screen review software and
  235. speech synthesizers know, it also makes their use by blind
  236. persons somewhat more problematic.  For this reason, RALPH THE
  237. READER uses all normal DOS function calls.  Further, the control
  238. panel is designed to display its information in a consistent
  239. manner, making the program easy to use for blind persons.  
  240.  
  241.      Kansys, Inc. is currently working on a line of other
  242. software products employing this design philosophy.  We would
  243. appreciate your feedback on the success of this approach.  The
  244. next section will provide you with information on how to contact
  245. us.
  246.  
  247.                        RALPH AS SHAREWARE
  248.  
  249.      In order to get RALPH THE READER to the maximum number of
  250. people who can benefit from it, and to hold the cost down, we
  251. have decided to distribute it as shareware.  This also means that
  252. you can try out the program before you pay for it and if you
  253. don't like it, you don't have to pay for it.  However, if you do
  254. like and/or use the program, please pay for it.  We also
  255. encourage you to share copies of RALPH with your friends and to
  256. upload it to bulletinboards.
  257.  
  258.      The cost of RALPH THE READER is $10.00, (ten dollars.)  This
  259. is a small cost to pay for a program that you will probably use
  260. every day.  While RALPH looks very simple to the end user,
  261. believe us when we tell you that many hours of coding and testing
  262. have gone into its design, implementation and distribution.  In
  263. order for us to continue to produce programs for the blind and
  264. general markets, we need to receive some return for our efforts.
  265.  
  266.      Please make all checks payable to Kansys, Inc., and send
  267. them to:
  268.  
  269. Kansys, Inc.
  270. 1016 Ohio Street
  271. Lawrence, KS  66044
  272. Telephone:  (913) 843-0351
  273.  
  274.      Please write or call us if you have any problems, questions,
  275. feedback or other needs.  You can also contact us via electronic
  276. mail.  The addresses include:
  277.  
  278. CompuServe 72157,3547
  279. GENIE d.andrews
  280.  
  281.                    OTHER KANSYS, INC. PRODUCTS
  282.  
  283.      In addition to RALPH THE READER, Kansys, Inc. also writes
  284. and sells other software products.  These include:
  285.  
  286. PROVOX, a screen review program--$295.00
  287. NAMES, a program for managing lists of names and addresses--
  288. $79.00
  289. TURBO BRAILLE, a program for translating and formatting Grade II
  290. braille from ASCII, WordPerfect or Wordstar files--$249.00.
  291. WATCHDOG, a shareware utility for audibly monitoring output to
  292. your computer's screen--$10.00.
  293.  
  294.      In addition to these programs, we also sell speech
  295. synthesizers, produce custom braille materials and provide a
  296. variety of consulting services in the computer field.  For more
  297. information, please contact us.  We hope that you find RALPH THE
  298. READER to be as enjoyable and useful as we do!
  299.