home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional Developers Kit 1992 November / Disc01 / Disc01.mdf / runnable / toolkt20 / os2help / kwikinf.hlp (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1992-10-06  |  9.8 KB  |  255 lines

  1.  
  2. ΓòÉΓòÉΓòÉ 1. KwikINF Overview ΓòÉΓòÉΓòÉ
  3.  
  4. KwikINF provides a quick and convenient method of accessing help information in 
  5. OS/2* 2.0 online documents. Once KwikINF has been started, pressing a hot-key 
  6. sequence causes the program to pop up and search for a text string of your 
  7. choice. 
  8.  
  9. KwikINF searches the subdirectories specified in the BOOKSHELF environment 
  10. variable for online documents. BOOKSHELF is an environmental variable, set in 
  11. CONFIG.SYS, that contains a list of subdirectories containing online documents. 
  12.  
  13. The hot-key, which can be redefined, activates a Search window that lets you 
  14. specify the string KwikINF is to search for. Under certain circumstances, 
  15. KwikINF can automatically retrieve the word at the current cursor position and 
  16. place it in the entry field of the Search window. This text retrieval feature 
  17. is active in OS/2* full-screen and Presentation Manager (PM) multi-line entry 
  18. (MLE) fields. The text retrieval feature is not active in PM windows, AVIO 
  19. windows, DOS windows, or WINOS2 windows. 
  20.  
  21. The hot-key activation is not available in DOS or WINOS2 full screen sessions. 
  22.  
  23. Once the desired help text is displayed, the user can toggle back to the 
  24. calling editor or application by pressing the hot-key sequence again. 
  25.  
  26. The files required for using KwikINF are installed with the Developer's Toolkit 
  27. for OS/2* 2.0. 
  28.  
  29.  
  30. ΓòÉΓòÉΓòÉ 2. Using KwikINF ΓòÉΓòÉΓòÉ
  31.  
  32. Pressing the hot-key sequence brings to the foreground KwikINF's Search window. 
  33.  
  34.  KwikINF will work in any of the OS/2 sessions types:  full screen, AVIO 
  35. window, and PM window. If your application is running in a full-screen session 
  36. or an active PM window is a multi-line entry (MLE) field, KwikINF will retreive 
  37. the word the cursor is on and automatically place it in the entry field of the 
  38. Search window. In PM and AVIO windows, the user may use the hot-key sequence to 
  39. display the search window; however, you must enter the search string manually. 
  40. KwikINF does not pre-fill the search string field for PM and AVIO windows. 
  41. KwikINF cannot determine the word under the cursor in these types of sessions 
  42. because they are graphics sessions and the characters are stored as bit maps 
  43. rather than as characters. 
  44.  
  45. To find information on a string, take the following steps: 
  46.  
  47. o If you are in a full-screen session or MLE window, position the cursor on the 
  48.   string you want to search for, then press the hot-key sequence. KwikINF 
  49.   retrieves the word at the cursor and places it in the entry field of the 
  50.   Search window. 
  51.  
  52. o If you are in a PM window or an AVIO session, press the hot-key sequence, 
  53.   then type the word to search for in the entry field of the Search window. 
  54.  
  55. KwikINF then takes you to the entry for the search string in the online 
  56. document. 
  57.  
  58.  
  59. ΓòÉΓòÉΓòÉ 3. Command Line Options ΓòÉΓòÉΓòÉ
  60.  
  61. You can specify three KwikINF options from the command line. An example of the 
  62. command line syntax follows: 
  63.  
  64. KwikINF [/C] [/T] [/?]
  65.  
  66. where: 
  67.  
  68. KwikINF 
  69.   entering KwikINF at the command prompt with no options specified will start 
  70.   KwikINF. After entering this command, the default hot-key sequence (ALT + Q) 
  71.   is enabled. 
  72.  
  73. /T 
  74.   entering the /T option will terminate KwikINF and disable the hot-key 
  75.   sequence. KwikINF will be terminated for all active sessions. 
  76.  
  77. /C 
  78.   entering the /C option will display the Configure KwikINF window. Use the 
  79.   Configure KwikINF window to customize KwikINF values. 
  80.  
  81. /? 
  82.   entering the /? will display the following information. 
  83.  
  84.      Usage: KwikINF [Option]
  85.       Option    Description
  86.         /C      Configure KwikINF
  87.         /T      Terminate KwikINF
  88.         /?      This short help list
  89.  
  90.  
  91. ΓòÉΓòÉΓòÉ 4. Help for Configure KwikINF ΓòÉΓòÉΓòÉ
  92.  
  93. The Configure KwikINF window contains fields that enable you to: 
  94.  
  95. o Activate the hot-key of your choice 
  96. o Monitor 1 to 12 OS/2* full-screen sessions 
  97. o Specify the name of online document KwikINF searches by default 
  98. o Indicate the type of search mode. 
  99.  
  100. Push Buttons 
  101.  
  102. o Select the OK push button to activate all changes. 
  103. o Select the Cancel push button to cancel a search request and minimize KwikINF 
  104.   to a unique icon. 
  105. o Select the Help push button to get general help for the current window. 
  106.  
  107.  
  108. ΓòÉΓòÉΓòÉ 4.1. Activation Key Sequence ΓòÉΓòÉΓòÉ
  109.  
  110. The Activation Key Sequence selection provides a list of available hot-key 
  111. combinations. To access the list, single-click on the down arrow, Select the 
  112. key combination that activates the command line KwikINF search mechanism. This 
  113. key combination also lets you obtain instant access to information in each of 
  114. the Toolkit online documents. 
  115.  
  116. Valid key combinations 
  117.  
  118.    CTRL + A 
  119.    CTRL + H 
  120.    CTRL + Q 
  121.    ALT + A 
  122.    ALT + Q 
  123.  
  124. To find information, position the cursor at the end of the text string you want 
  125. KwikINF to find and press Alt + Q (or whatever hot-key combination you selected 
  126. from the list). 
  127.  
  128.  
  129. ΓòÉΓòÉΓòÉ 4.2. Full Screen Sessions ΓòÉΓòÉΓòÉ
  130.  
  131. Use the Number of Fullscreen Sessions to Monitor spin button to set the number 
  132. of OS/2* full-screen sessions that KwikINF monitors. The term monitor means 
  133. that KwikINF enables the search mechanism, and controls system resources of all 
  134. OS/2 full-screen sessions up to the number specified here. 
  135.  
  136.  
  137. ΓòÉΓòÉΓòÉ 4.3. Default Volume to Search ΓòÉΓòÉΓòÉ
  138.  
  139. Use the Default Volume to Search single selection list box to specify which 
  140. online document you want KwikINF to search by default.  Select the online 
  141. document, then select the OK push button to activate the selection. 
  142.  
  143. The online documents presented in this list are found in the subdirectories 
  144. specified in the BOOKSHELF environment variable in CONFIG.SYS.  To make other 
  145. online documents available to KwikINF, add their directory location to the 
  146. BOOKSHELF environment variable. 
  147.  
  148.  
  149. ΓòÉΓòÉΓòÉ 4.4. Activation Behavior ΓòÉΓòÉΓòÉ
  150.  
  151. Use the radio buttons in the Activation Behavior section to select a mode of 
  152. operation. KwikINF starts the mode of operation when you type a text string 
  153. from an OS/2* command line or position the cursor at the end of a text string 
  154. in your program. 
  155.  
  156. o Select the Display Search Window radio button to tell KwikINF that you always 
  157.   want searches performed through the Search Window. 
  158.  
  159. o Select the Default Search radio button to tell KwikINF that you want to 
  160.   bypass the Search Window and go directly to the online document. 
  161.  
  162. o To bring up the Configuration Window while in bypass mode, press the SHIFT + 
  163.   hot-key sequence the user has selected. 
  164.  
  165.  
  166. ΓòÉΓòÉΓòÉ 5. Help for Search Window ΓòÉΓòÉΓòÉ
  167.  
  168. Make sure you type the text string in the Search String entry field.  Select 
  169. the online document, then select the Search push button or press Enter. If the 
  170. search is successful, KwikINF displays a window with a title bar that matches 
  171. the search string. 
  172.  
  173. If the search is not successful, you can search all online documents by 
  174. following this procedure: 
  175.  
  176. o Clear the Search String entry field. 
  177. o Select an online document.  The Contents window of the online document 
  178.   appears. 
  179. o Select Services from the menu bar. 
  180. o Select Search.  The Search window appears. 
  181. o Type the text string, then select the All libraries radio button. 
  182. o Select the Search push button or press Enter. 
  183.  
  184. Note:  If you have configured KwikINF to always display the Search Window, then 
  185.        the window will appear after you type a text string and press Alt + Q at 
  186.        the command line. When the search is complete, KwikINF highlights the 
  187.        online document that contains the first occurrence of the search string. 
  188.        Select the Search push button or press Enter to display a window with a 
  189.        title bar that matches the search string. 
  190.  
  191. Push Buttons 
  192.  
  193. o Select the Search push button to find the text string in the Search String 
  194.   entry field. 
  195. o Select the Cancel push button to cancel a search request and minimize KwikINF 
  196.   to a unique icon. 
  197. o Select the Configuration push button to display the Configure KwikINF window. 
  198. o Select the Help push button to get general help for the current window. 
  199.  
  200.  
  201. ΓòÉΓòÉΓòÉ 5.1. Search String field ΓòÉΓòÉΓòÉ
  202.  
  203. Use the Search String entry field to enter the text string that you want 
  204. KwikINF to find.  You may type any text string you want into this field.  All 
  205. characters are valid in the entry field to allow for special search criteria. 
  206. The search string field is automatically filled for you if you press the 
  207. hot-key sequence during an editor session.  KwikINF uses some special rules in 
  208. pre-filling the search string field. The allowable characters are letters, 
  209. numbers, underscores, and the pound sign. Blank spaces and other special 
  210. characters are used as delimiters and not in pre-filling of the search string 
  211. field.  You may override this by first selecting the desired text and then 
  212. pressing the hot-key sequence.  Using this method, you can pre-fill the search 
  213. string field with special characters. 
  214.  
  215.  
  216. ΓòÉΓòÉΓòÉ 5.2. Volume to Search ΓòÉΓòÉΓòÉ
  217.  
  218. Use the Volume to Search single selection list box to specify which online 
  219. document you want KwikINF to search. 
  220.  
  221. The online documents presented in this list are found in the subdirectories 
  222. specified in the BOOKSHELF environment variable in CONFIG.SYS.  To make other 
  223. online documents available to KwikINF, add their directory location to the 
  224. BOOKSHELF environment variable. 
  225.  
  226.  
  227. ΓòÉΓòÉΓòÉ 6. Error Messages ΓòÉΓòÉΓòÉ
  228.  
  229. Entering an invalid option parameter on the command line is detected as an 
  230. error.  The following message is displayed: 
  231.  
  232. ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
  233. Γöé  Invalid Command-Line argument found Γöé
  234. ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
  235.  
  236. If KwikINF is not running and an attempt is made to configure it by using the 
  237. command line, the following message is displayed: 
  238.  
  239. ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
  240. Γöé          KwikINF Not Installed       Γöé
  241. Γöé           /? for Option List         Γöé
  242. ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
  243.  
  244.  
  245. ΓòÉΓòÉΓòÉ <hidden> IBM Trademark ΓòÉΓòÉΓòÉ
  246.  
  247. Trademark of the IBM Corporation. 
  248.  
  249.  
  250. ΓòÉΓòÉΓòÉ <hidden> KwikINF Keys Help ΓòÉΓòÉΓòÉ
  251.  
  252. Use the configured hot-key sequence to activate the search window. 
  253.  
  254. To bring up the Configuration Window while in bypass mode, press the SHIFT + 
  255. hot-key sequence the user has selected.