home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / epmspch.zip / README.TXT < prev    next >
Text File  |  1995-11-10  |  5KB  |  105 lines
  1. Brief documentation for EPM Speech Support Manager
  2.  
  3. ----- Description -----
  4. EPM Speech Support Manager allows you to have dictation in any
  5. application using EPM windows or the E-MLE.  It works with the
  6. IBM Personal Dictation System, and uses the power of the E
  7. Toolkit rather than the IPDS Dictation window.
  8.  
  9. ----- Installation -----
  10. Copy EPMSPCH.EXE to a directory in your PATH, ETKSPCH.DLL to a directory
  11. in your LIBPATH.  If using EPM 5.51, copy ETKSPCH.551 to a directory in
  12. your EPMPATH, renaming it to ETKSPCH.EX.  If using EPM 6.03a, do the same
  13. for ETKSPCH.603.  (If using both, the 5.51 version .ex file should be
  14. found before the 6.03 version so that both versions will work properly.
  15. If using a different version of EPM, recompile ETKSPCH.E with the
  16. appropriate version of ETPM.)  If using EPM 6 and you want to add speech
  17. support to the toolbar, copy the BMP files to your EPM directory or a
  18. directory in your EPMPATH.
  19.  
  20. ----- Using EpmSpch -----
  21. The package consists of an EXE, a DLL, and EX files.  It can be started
  22. from the edit window or from an OS/2 command window.  It runs in a
  23. separate process, and so can be used in different applications, even if
  24. you close the application that first started the speech connection.
  25.  
  26. EpmSpch accepts the following options:
  27.  
  28. /MIN        Start minimized.
  29. /CONNECT    Tries to start a session with the speech engine.  If no user
  30.             id, enrollment id or task name is specified, the user
  31.             information dialog will pop up before starting the session.
  32. /NOLOG      No logging information displayed in the EPMSPCH window.
  33. /HWND=      The edit window specified is selected and receives the speech
  34.             focus.
  35. /USERID=    Speaker ID used for the session.
  36. /ENROLLID=  Enrollment ID
  37. /TASK=      Task name (usually STARTUS)
  38.  
  39. Note:  The userid, enroll ID, task name and log level are saved in the
  40. INI file so you don't need to set them every time.  The window positions
  41. and presentation parameters are also saved.
  42.  
  43. To start from an edit window, link the appropriate .ex file and execute
  44. the command SpStartDictationSupport.  This will start EpmSpch minimized,
  45. autoconnected, and with the current edit window selected.
  46.  
  47. ----- Speech Focus -----
  48. Since you can have multiple applications using several edit windows on
  49. your screen, EpmSpch has to know which one is going to receive the
  50. recognized words and display them.  This is called the speech focus.  If
  51. EpmSpch is started from an edit window, that window automatically
  52. receives the speech focus.  To give the focus to another window, you can
  53. use the Select option from the EpmSpch menu.  The mouse pointer will
  54. change to a +, indicating that you can choose which window you want to
  55. select by clicking on it.
  56.  
  57. Starting EpmSpch with the /HWND= option is another way to give the focus
  58. to an edit window.
  59.  
  60. ----- E Macro Commands -----
  61. The following commands can be used by any edit window:
  62. SPStartDictationSupport  Starts the dictation support and gives the
  63.                          speech focus to the edit window.
  64. SPMikeOn                 Turns the mike on.
  65. SPMikeOff                Turns the mike off.
  66. SPCorrectWord            Corrects the word located at the cursor.
  67.  
  68. ----- How to configure your toolbar in EPM 6 -----
  69. Add the following items to your toolbar :
  70.  
  71. 1. Bmp    : SPEECH.BMP
  72.    Action : Function : *
  73.             Param    : mc /link epmspch/SPStartDictationSupport
  74.    (to start and initialize  EPM speech manager from EPM)
  75.  
  76. 2. Bmp    : MIKEON.BMP
  77.    Action : Function : *
  78.             Param    : SPMikeOn
  79.  
  80. 3. Bmp    : MIKEOFF.BMP
  81.    Action : Function : *
  82.             Param    : SPMikeOff
  83.  
  84. ----- Correction Context Menu -----
  85. A double-click on a word with mouse button 1 will bring up the correction
  86. context menu and automatically replay the word.  It allows you to replay
  87. the word (to recall what you said), perform some formatting commands,
  88. delete it, or replace it with one of the alternate words which the decode
  89. found.  The maximum number of alternates has been set to 10; this can be
  90. changed by modifying the MAXNBOFALTERNATES constant in ETKSPCH.E and
  91. recompiling the macro with ETPM.
  92.  
  93. If you double-click on a word that was not dictated, the pop-up menu will
  94. not appear.
  95.  
  96. ----- Logging Information -----
  97. EpmSpch has a logging facility.  It can display messages in the EpmSpch
  98. status window.  The log level can be set using the Logging menu item.
  99. (Multiple levels can be active at the same time.)  The levels are:
  100. ERRORS   Display all error messages (from the speech engine or EpmSpch)
  101. MESSAGES Display all status messages (e.g., mike on or mike off)
  102. E-MACROS Displays all E-Macro commands before posting them to the edit
  103.          window
  104. WORDS    Displays all the words that are recognized by the engine
  105.