home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / mmpm21tk.zip / TK / CAPTION / CAPTION.IPF < prev    next >
Text File  |  1992-12-18  |  11KB  |  221 lines
  1. :userdoc.
  2.  
  3. .***********************************************************************
  4. .*General help for the Caption Creation Utility
  5. .***********************************************************************
  6.  
  7. :h1 res=10500 nosearch noprint.System overview
  8. :i1.System overview
  9. Welcome to MMPM/2's sample captioning system.  We call it our sample
  10. captioning system because we've provided it, source code and all, as an
  11. example of one way to implement captioning with MMPM/2.  The system can be
  12. used as it's provided, or it can be modified to suit your specific needs.
  13. :p.
  14. This sample captioning system is made up of three parts.  The first part of
  15. the system is this application, the Caption Creation Utility.  This allows
  16. you to synchronize an audio file with a text file.  The second part of the
  17. system is the Caption DLL.  This DLL provides three api's that allow an
  18. application to display, manage, and hide a caption window.  The third part
  19. of the system is Caption Sample Application.  It shows programmers how to
  20. use the three api's provided by the Caption DLL in order to display a caption
  21. window in an application.
  22. :sl.
  23. :li.To add captions to an audio file&colon.
  24. :ol.
  25. :li.Choose an audio file by selecting :hp2.Open audio...:ehp2. in the :hp2.File:ehp2. submenu.
  26. :li.Choose a text file by selecting :hp2.Open text...:ehp2. in the :hp2.File:ehp2. submenu.
  27. :li.Select :hp2.Start timing:ehp2. to start playing the audio.
  28. :li.As the audio plays, select :hp2.Advance line:ehp2. to scroll the text to match the audio.
  29. :li.Once the audio has completed, select :hp2.Review:ehp2. to check the timing.
  30. :li.You may repeat steps :hp2.3:ehp2. through :hp2.5:ehp2. above until the timing is satisfactory.
  31. :li.If you wish to retime just a portion of the file, use the :hp2.Audio position:ehp2.
  32. slider bars to locate the part you wish to retime, and then
  33. follow steps :hp2.3:ehp2. through :hp2.5:ehp2 above.
  34. :li.Select :hp2.Save as...:ehp2. from the :hp2.File:ehp2. submenu to save the caption file.
  35. :eol.
  36. :li.To review an existing Caption file&colon.
  37. :ol.
  38. :li.Choose an Audio file by selecting :hp2.Open audio...:ehp2. in the :hp2.File:ehp2. submenu.
  39. :li.Choose a Caption file by selecting :hp2.Open captions...:ehp2. in the :hp2.File:ehp2. submenu.
  40. :li.Use the :hp2.Audio position:ehp2. or :hp2.Text position:ehp2. slider bars to locate
  41. the portion of the file you wish to review.
  42. :li.Select :hp2.Play:ehp2. to check the timing.
  43. :eol.
  44. :p.Select :hp2.Start timing :ehp2. to synchronize the text captions with
  45. the audio file.  The audio file will begin playing from its current position
  46. when this button is selected.  As the audio plays, select
  47. the :hp2.Advance line:ehp2. button to scroll new caption lines into the
  48. text window.
  49. .*
  50. :p.Select :hp2.Play:ehp2. to review a caption file.  While the audio
  51. plays, the captions scroll by in the text window just as they would in the
  52. target application. This function can be used to check the captioning
  53. just after its timing has been set with the :hp2.Start timing:ehp2. function,
  54. or it can be used to review an existing Caption file.
  55. .*
  56. :p.Select :hp2.Advance line:ehp2. to scroll a new line of text into the text
  57. window during the :hp2.Start timing:ehp2. function.  The timing of
  58. the :hp2.Advance line:ehp2. events will be stored for subsequent
  59. :hp2.Play:ehp2., :hp2.Save:ehp2. and/or :hp2.Save as...:ehp2. operations.
  60. .*
  61. :p.Select :hp2.Pause:ehp2. to temporarily suspend a :hp2.Start timing:ehp2. or
  62. :hp2.Play:ehp2. operation before the audio has finished playing.  While the
  63. audio is paused, the indicator on the button will remain highlighted.  A paused
  64. operation may be subsequently resumed by selecting the :hp2.Pause:ehp2. button
  65. again, or it can be terminated altogether by selecting :hp2.Stop:ehp2..
  66. .*
  67. :p.Select :hp2.Stop:ehp2. to terminate a :hp2.Start timing:ehp2. or
  68. :hp2.Play:ehp2. operation before the audio has completed playing.
  69. .*
  70. :p.Adjust the audio volume to a comfortable level by using the :hp2.Volume
  71. control:ehp2..
  72. .*
  73. :p.The :hp2.Audio position:ehp2. control provides a graphic display of the
  74. current position of the audio file.  To change the audio position, drag the
  75. slider bar or select the pushbuttons at the left end of the slider.  If there
  76. is caption text present in the text window, the program will adjust its
  77. position to match the new position of the audio file.
  78. .*
  79. :p.Select the :hp2.File:ehp2. submenu to open or save the files
  80. used by the application.
  81. .*
  82. :p.Select the :hp2.Open:ehp2. submenu to specify the Audio, Text or Caption
  83. file which you wish to open.
  84. .*
  85. :p.Select the :hp2.Audio...:ehp2. menu item to specify the audio file which
  86. you wish to caption. You will be promped by a file dialog box showing only
  87. those files having an extension of :hp2.WAV:ehp2..
  88. .*
  89. :p.Select the :hp2.Text...:ehp2. menu item to specify a text file which you
  90. want to use as captions for an audio file.  You will be prompted with a file
  91. dialog box showing all of the files in your system having the extension
  92. of :hp2.TXT:ehp2..
  93. .*
  94. :p.Select the :hp2.Caption...:ehp2. menu item to specify a Caption file which
  95. was previously created by the Caption Creation Utility.  You will be prompted
  96. with a file dialog box showing all of the files in your system having the
  97. extension of :hp2._CC:ehp2..
  98. .*
  99. :p.Select :hp2.Save:ehp2. to save the current caption file.
  100. .*
  101. :p.Select :hp2.Save as...:ehp2. to save a Caption file after you have timed
  102. and reviewed it.  Selecting :hp2. Save as...:ehp2. will allow you to choose
  103. a name for the file being saved.
  104. .*
  105. :p.Select the :hp2.Exit:ehp2. menu item when you wish to exit the Caption
  106. Creation Utility.
  107. .*
  108. :p.Select the :hp2.Options:ehp2. submenu to control how many caption lines are
  109. displayed in the text window.
  110. .*
  111. :p.Select the :hp2.Caption lines:ehp2. menu item to select one of the menu
  112. items to control the number of lines of captioning displayed in the text window.
  113. A check mark appears to the left of the number which is currently selected.
  114. .*
  115. :p.Use the :hp2.Help:ehp2. submenu to access the help information for this program.
  116. :esl.
  117.  
  118. .***********************************************************************
  119. .*Help for Keys
  120. .***********************************************************************
  121.  
  122. :h1 hide res=10524 nosearch noprint.Help for keys
  123. :i1.Keys
  124. :dl tsize=10.
  125. :dt.:hp5.Key:ehp5.:hp2. :ehp2.
  126. :dd.:hp5.Function:ehp5.
  127. :dt.:hp2.Alt:ehp2.
  128. :dd.Highlight menu items.
  129. :dt.:hp2.Arrows:ehp2.
  130. :dd.Move to another menu item.
  131. :dt.:hp2.Enter:ehp2.
  132. :dd.Select a control or a menu item.
  133. :dt.:hp2.Tab:ehp2.
  134. :dd.Move from one dialog box control to another.
  135. :dt.:hp2.F1:ehp2.
  136. :dd.Display help information for highlighted item.
  137. :dt.:hp2.F3:ehp2.
  138. :dd.Exit the program.
  139. :dt.:hp2.A:ehp2.
  140. :dd.Advance the text one line while setting timing.
  141. :dt.:hp2.Alt + A:ehp2.
  142. :dd.Open an audio file.
  143. :dt.:hp2.Alt + C:ehp2.
  144. :dd.Open a caption file.
  145. :dt.:hp2.E:ehp2.
  146. :dd.Pause or resume the current operation.
  147. :dt.:hp2.P:ehp2.
  148. :dd.Play the audio file while scrolling the captions.
  149. :dt.:hp2.R:ehp2.
  150. :dd.Rewind the audio and caption files.
  151. :dt.:hp2.S:ehp2.
  152. :dd.Stop the current operation.
  153. :dt.:hp2.Alt + S:ehp2.
  154. :dd.Save the caption file which is currently open.
  155. :dt.:hp2.T:ehp2.
  156. :dd.Start the timing operation.
  157. :dt.:hp2.Alt + T:ehp2.
  158. :dd.Open a text file
  159. :dt.:hp2.Alt + V:ehp2.
  160. :dd.Save captions under a selected name.
  161. :dt.:hp2.Alt + 2:ehp2.
  162. :dd.Display two lines in the text window.
  163. :dt.:hp2.Alt + 3:ehp2.
  164. :dd.Display three lines in the text window.
  165. :dt.:hp2.Alt + 4:ehp2.
  166. :dd.Display four lines in the text window.
  167. :dt.:hp2.Alt + 5:ehp2.
  168. :dd.Display five lines in the text window.
  169. :dt.:hp2.Alt + 6:ehp2.
  170. :dd.Display six lines in the text window.
  171. :edl.
  172.  
  173. .***********************************************************************
  174. .*Help for Open Audio file   (D)
  175. .***********************************************************************
  176. :h1 hide res=4163 nosearch noprint.Help for Open Audio
  177. :p.The :hp2.Drive:ehp2. list box displays the drives on your system.  Select
  178. the drive that contains the audio files you want to caption.
  179. :p.The :hp2.Directory:ehp2. list box displays the directories on the selected
  180. drive.  Select a directory to display the list of files from that directory
  181. in the :hp2.File:ehp2. list box.
  182. :p.Select an audio file from the :hp2.File:ehp2. list box or type in a file name
  183. that you want to caption.
  184. :p.Select the :hp2.OK:ehp2. pushbutton to load the selected audio file to
  185. caption and to remove this pop-up window.
  186. :p.Select the :hp2.Cancel:ehp2. pushbutton to remove this pop-up window.
  187. :p.Select the :hp2.Help:ehp2. pushbutton to view this help panel.
  188.  
  189. .***********************************************************************
  190. .*Help for Open Text file   (D)
  191. .***********************************************************************
  192. :h1 hide res=4164 nosearch noprint.Help for Open Text
  193. :p.The :hp2.Drive:ehp2. list box displays the drives on your system.  Select the
  194. drive that contains the text files you want to use.
  195. :p.The :hp2.Directory:ehp2. list box displays the directories on the selected
  196. drive.  Select a directory to display the list of files from that directory
  197. in the :hp2.File:ehp2. list box.
  198. :p.Select a text or caption file from the :hp2.File:ehp2. list or type in a file name
  199. that you want to use.
  200. :p.Select the :hp2.OK:ehp2. pushbutton to load the selected file to use
  201. and to remove this pop-up window.
  202. :p.Select the :hp2.Cancel:ehp2. pushbutton to remove this pop-up window.
  203. :p.Select the :hp2.Help:ehp2. pushbutton to view this help panel.
  204. .***********************************************************************
  205. .*Help for Save Caption File (D)
  206. .***********************************************************************
  207. :h1 hide res=4165 nosearch noprint.Help for Save Caption
  208. :p.Type the name of the file you want to save in the
  209. :hp2.File name:ehp2. field
  210. :p.The program is preset to use the name of the audio file with the extension
  211. :hp2.._CC:ehp2.
  212. :p.The :hp2.Drive:ehp2. list displays the drives on your system.  Select the
  213. drive where you want to save the caption file.
  214. :p.Select the :hp2.Save as:ehp2. pushbutton to save the caption data under
  215. the selected file name.
  216. :p.Select the :hp2.Cancel:ehp2. pushbutton to remove this pop-up window.
  217. :p.Select the :hp2.Help:ehp2. pushbutton to view this help panel.
  218. .*************************************************************************
  219.  
  220. :euserdoc.
  221.