home *** CD-ROM | disk | FTP | other *** search
/ The Developer Connection…ice Driver Kit for OS/2 3 / DEV3-D1.ISO / devtools / toolkt21 / os2help / kwikinf.hlp (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1993-04-22  |  14.8 KB  |  410 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. KwikINF overview ΓòÉΓòÉΓòÉ
  3.  
  4. KwikINF provides you with a quick and convenient method of accessing 
  5. information in online documents stored in the OS/2* 2.x BOOKSHELF from anywhere 
  6. on the desktop, with the exception of DOS or WIN-OS/2 sessions. When KwikINF 
  7. has been started, you can open a dialog with KwikINF by pressing a 
  8. user-selectable hot key.  Until you configure KwikINF, your KwikINF hot key is 
  9. ALT+Q. The KwikINF window includes a Configure push button.  This opens another 
  10. dialog with KwikINF:  the Configure KwikINF window. The KwikINF window also 
  11. allows you to initiate searches for text strings in online documents of choice. 
  12.  
  13.  
  14. ΓòÉΓòÉΓòÉ 1.1. Automatic text-retrieval ΓòÉΓòÉΓòÉ
  15.  
  16. The KwikINF window includes a Search String entry field.  You can specify the 
  17. text string you want KwikINF to search for.  Or, under certain conditions, this 
  18. entry field automatically contains the word located under the cursor when you 
  19. press your KwikINF hot key. This text retrieval feature is available from OS/2 
  20. full-screen and Presentation Manager (PM) multi-line entry (MLE) fields.  This 
  21. feature is also available from PM AVIO and VIO windows. Communication Manager's 
  22. 3270 emulator is a common example of a PM AVIO window.  An OS/2 Window is a VIO 
  23. window.  This means that, if, for example, you open an OS/2 Window and start an 
  24. OS/2 text-based application, KwikINF will automatically retrieve the word under 
  25. the cursor when you press your KwikINF hot key. This automatic text-retrieval 
  26. feature is not available from graphic-text PM windows. 
  27.  
  28.  
  29. ΓòÉΓòÉΓòÉ 1.2. Online documents in the BOOKSHELF ΓòÉΓòÉΓòÉ
  30.  
  31. The KwikINF window includes a Volume to Search list box of all online documents 
  32. stored in the OS/2 BOOKSHELF subdirectories.  KwikINF initiates searches for 
  33. information in any online document in this list. 
  34.  
  35. The BOOKSHELF is an environment variable, set in CONFIG.SYS, that contains a 
  36. list of subdirectories containing online documents created as viewable .INF 
  37. files with the Information Presentation Facility (IPF). The BOOKSHELF 
  38. environment variable is set as follows: 
  39.  
  40. SET BOOKSHELF=<subdirectory>;...;<subdirectory>;
  41.  
  42. Online documents for OS/2 (for example, the Command Reference) are stored in 
  43. the \OS2\BOOK subdirectory of the drive on which OS/2 is installed.  Online 
  44. documents for the OS/2 Toolkit (for example, the Programming References) are 
  45. stored in the \TOOLKTxx\BOOK subdirectory of the drive specified during 
  46. installation of the online programming information.  As an example, after 
  47. installation of OS/2 and the OS/2 2.1 Toolkit, the BOOKSHELF environment 
  48. variable is set as follows: 
  49.  
  50. SET BOOKSHELF=C:\OS2\BOOK;C:\TOOLKT21\BOOK;
  51.  
  52. The online document where KwikINF looks for the Search String is selected from 
  53. the Volume to Search list box by KwikINF or by you.  KwikINF selects the Volume 
  54. to Search by looking for the text string that has a matching entry in the 
  55. KwikINF index file or, if there is no matching entry in the index file, in the 
  56. Default Volume you have selected in the Configure KwikINF window. 
  57.  
  58.  
  59. ΓòÉΓòÉΓòÉ 1.3. Index files for rapid-searches ΓòÉΓòÉΓòÉ
  60.  
  61. The KwikINF index file provides a rapid-search mechanism for locating specific 
  62. kinds of information in online documents in the BOOKSHELF. The KwikINF index 
  63. file consists of one or more concatenated files stored in the BOOKSHELF and 
  64. defined by the HELPNDX variable in CONFIG.SYS as shown in the following 
  65. example: 
  66.  
  67. SET HELPNDX=EPMKWHLP.NDX
  68.  
  69. where EPMKWHLP.NDX is the KwikINF index file for the OS/2 Toolkit. 
  70.  
  71. As an example, the following excerpt from the KwikINF index file for the OS/2 
  72. Toolkit: 
  73.  
  74. EXTENSIONS: *
  75. DESCRIPTION: IBM Developer's Toolkit for OS/2 2.1
  76. (IPF*, view ipfc20.inf ~)
  77. (WinCreateWindow, view pmwin.inf ~)
  78.  
  79. is used by KwikINF to quickly locate Search String entries with the prefix IPF 
  80. in the IPF-viewable file IPFC20.INF. and to quickly locate the specific Search 
  81. String entry WinCreateWindow in the IPF-viewable file PMWIN.INF. 
  82.  
  83. The first token in a rapid-search string is a specific text string (for 
  84. example, WinCreateWindow) or prefix wildcard (for example, IPF*).  The second 
  85. token is the name of the IPF file viewer (VIEW.EXE).  The third and fourth 
  86. tokens are parameters for VIEW.EXE:  the name of the .INF file that contains 
  87. the online document and the text-string you want VIEW.EXE to locate within the 
  88. online document.  The ~ character tells KwikINF to use the first token in the 
  89. rapid-search string as the text-string to locate within the online document. 
  90.  
  91.  
  92. ΓòÉΓòÉΓòÉ 1.4. Enabling any online document for KwikINF ΓòÉΓòÉΓòÉ
  93.  
  94. You can enable any online document for KwikINF by: 
  95.  
  96.  1. Creating the online document as a viewable .INF file using the Information 
  97.     Presentation Facility (IPF). 
  98.  2. Adding the name of the subdirectory where it is stored to the PATH 
  99.     statement in CONFIG.SYS 
  100.  3. Appending the name of the subdirectory where it is stored to the BOOKSHELF 
  101.     in CONFIG.SYS 
  102.  4. Creating an index file to support the KwikINF rapid-search mechanism, 
  103.     storing it in the BOOKSHELF, and adding it to the HELPNDX variable in 
  104.     CONFIG.SYS. 
  105.  
  106. For example, you can enable your online document MYDOC stored in MYSUBDIR 
  107. subdirectory for KwikINF by: 
  108.  
  109.  1. Compiling the tagged source for MYDOC with the IPF compiler by entering: 
  110.  
  111.         IPFC MYDOC /INF
  112.  
  113.  2. Modifying the PATH statement in CONFIG.SYS as follows: 
  114.  
  115.         SET PATH=...;C:\MYSUBDIR;
  116.  
  117.  3. Modifying the BOOKSHELF statement in CONFIG.SYS as follows: 
  118.  
  119.         SET BOOKSHELF=...;C:\MYSUBDIR;
  120.  
  121.  4. Creating MYINDEX file in MYSUBDIR as shown below: 
  122.  
  123.         /* C style comments and blank lines are acceptable */
  124.         /* specific file extensions may be specified here  */
  125.         EXTENSIONS: *
  126.         /* a title may be placed here                      */
  127.         DESCRIPTION: Any custom KwikINF index file
  128.         /* rapid-search strings                            */
  129.         (thisfunction, view mydoc.inf ~)
  130.         (my*, view mydoc.inf ~)
  131.  
  132.  5. Modifying the HELPNDX variable in CONFIG.SYS as follows: 
  133.  
  134.         SET HELPNDX=EPMKWHLP.NDX+MYINDEX
  135.  
  136. For more information on creating an IPF-viewable online document, see the IPF 
  137. Reference in the Toolkit Information folder. 
  138.  
  139.  
  140. ΓòÉΓòÉΓòÉ 2. Using KwikINF ΓòÉΓòÉΓòÉ
  141.  
  142. KwikINF is installed as a program object in the OS/2 2.1 Toolkit Information 
  143. folder.  You start KwikINF by double-clicking on the KwikINF object or by 
  144. entering KwikINF from the command line of an OS/2 Window. You can start KwikINF 
  145. automatically when you start OS/2 by placing a shadow of the KwikINF object in 
  146. the Startup folder in the OS/2 System folder on the desktop. You shadow an 
  147. object by pressing CTRL + SHIFT while dragging the object. 
  148.  
  149. KwikINF installs a PM system hook to monitor keystrokes in PM sessions and OS/2 
  150. character device monitors to monitor keystrokes in OS/2 full-screen sessions. 
  151. KwikINF will install only one copy of the hook and monitors, even if you 
  152. attempt to re-start KwikINF. 
  153.  
  154. When KwikINF has been started, you can initiate searches for text strings in 
  155. online documents of choice by pressing a user-selectable hot key. 
  156.  
  157. Note:  You cannot initiate searches for text strings in online documents from 
  158.        DOS or WIN-OS/2 sessions. 
  159.  
  160. Until you configure KwikINF, your KwikINF hot key is ALT+Q.  You configure 
  161. KwikINF by pressing your KwikINF hot key and then pressing the Configure push 
  162. button to open the Configure KwikINF window. 
  163.  
  164. Note:  When you start KwikINF by double-clicking on the KwikINF object in the 
  165.        Toolkit Information folder, a message box tells you what hot key opens 
  166.        the KwikINF window.  This technique can also be used to determine what 
  167.        your current KwikINF hot key is, after KwikINF has been started. 
  168.  
  169. How you initiate a search for information in online documents is dependent on 
  170. where you are on the desktop when you press the KwikINF hot key: 
  171.  
  172. o From an OS/2 full-screen session, a PM VIO or AVIO window, or PM MLE: 
  173.   position the cursor on the string you want to search for and press the 
  174.   KwikINF hot key. KwikINF retrieves the word at the cursor.  If you have 
  175.   configured KwikINF to display the KwikINF window when the KwikINF hot key is 
  176.   pressed, KwikINF automatically places the retrieved word in the Search String 
  177.   entry field of the KwikINF window. When you press the Search push button or 
  178.   Enter, KwikINF displays the information. If you have configured KwikINF to 
  179.   bypass the KwikINF window when the KwikINF hot key is pressed,  KwikINF 
  180.   automatically displays the information. 
  181.  
  182.   If no word is under the cursor, the previous Search String is used. If no 
  183.   previous Search String exists, KwikINF displays the Contents of the Default 
  184.   volume to search. 
  185.  
  186. o From a graphic-text PM window: press the KwikINF hot key, then type the 
  187.   string you want to search for in the Search String entry field of the KwikINF 
  188.   window. The KwikINF text-retrieval feature is not available from graphic-text 
  189.   PM windows. 
  190.  
  191. The online document where KwikINF looks for the text string is selected from 
  192. the Volume to Search list box by KwikINF or by you. To open the online document 
  193. to the panel that contains the information, press the Search push button or 
  194. press Enter. 
  195.  
  196.  
  197. ΓòÉΓòÉΓòÉ 3. Invoking KwikINF from a command line ΓòÉΓòÉΓòÉ
  198.  
  199. You can start, terminate, and configure KwikINF from a command line in an OS/2 
  200. Window by entering: 
  201.  
  202. KwikINF [no options] [/C] [/T] [/?]
  203.  
  204. where: 
  205.  
  206. no options 
  207.   starts KwikINF. After entering this command, the default KwikINF hot key (ALT 
  208.   + Q) is enabled. 
  209.  
  210. /T 
  211.   terminates KwikINF and disables the KwikINF hot key. 
  212.  
  213. /C 
  214.   opens the Configure KwikINF window. Use this window to select another KwikINF 
  215.   hot key, to select a default online document from the BOOKSHELF to search, 
  216.   and to select the activation behavior of the KwikINF window. 
  217.  
  218. /? 
  219.   displays the following information. 
  220.  
  221.      Usage: KwikINF [Option]
  222.       Option    Description
  223.         /C      Configure KwikINF
  224.         /T      Terminate KwikINF
  225.         /?      This short help list
  226.  
  227.  
  228. ΓòÉΓòÉΓòÉ 4. Configuring KwikINF ΓòÉΓòÉΓòÉ
  229.  
  230. You configure KwikINF through the Configure KwikINF window. KwikINF displays 
  231. this window when you press the Configure push button on the KwikINF window or 
  232. when you enter the following from the command line of an OS/2 Window: 
  233.  
  234. KwikINF /C
  235.  
  236. The Configure KwikINF window allows you to: 
  237.  
  238. o Select another KwikINF hot key 
  239. o Specify the number of OS/2 full-screen sessions enabled for KwikINF 
  240. o Specify the name of the default online document KwikINF searches 
  241. o Select the activation behavior of the KwikINF window. 
  242.  
  243. Use the push buttons on the Configure KwikINF window as follows: 
  244.  
  245. o Press OK to enable your configuration choices. 
  246. o Press Cancel to cancel your configuration choices. This closes the Configure 
  247.   KwikINF window. 
  248. o Press Help to get general help for the current window. 
  249.  
  250.  
  251. ΓòÉΓòÉΓòÉ 4.1. Activation Key Sequence ΓòÉΓòÉΓòÉ
  252.  
  253. The Activation Key Sequence provides a selectable list of KwikINF hot keys. To 
  254. access the list, single-click on the down arrow. Select the KwikINF hot key of 
  255. your choice from the following list: 
  256.  
  257. CTRL + A 
  258. CTRL + H 
  259. CTRL + Q 
  260. ALT + A 
  261. ALT + Q (this is the default hot key) 
  262.  
  263. The KwikINF hot key initiates searches for information in online documents from 
  264. anywhere on the desktop, with the exception of DOS or WIN-OS/2 sessions. 
  265.  
  266.  
  267. ΓòÉΓòÉΓòÉ 4.2. Full Screen Sessions ΓòÉΓòÉΓòÉ
  268.  
  269. Use the Number of Fullscreen Sessions to Monitor spin button to specify the 
  270. number of OS/2 full-screen sessions enabled for KwikINF.  KwikINF is 
  271. implemented as a PM system hook to monitor keystrokes in PM sessions and as 
  272. OS/2 character device monitors to monitor keystrokes in OS/2 full-screen 
  273. sessions.  For OS/2 full-screen sessions,  KwikINF will monitor only the number 
  274. of sessions specified here. 
  275.  
  276.  
  277. ΓòÉΓòÉΓòÉ 4.3. Default Volume to Search ΓòÉΓòÉΓòÉ
  278.  
  279. Use the Default Volume to Search single selection list box to specify which 
  280. online document in the BOOKSHELF you want KwikINF to search by default. 
  281. KwikINF looks for the Search String in this online document, when there is no 
  282. matching entry in the KwikINF index file. Select the online document, then 
  283. select the OK push button to activate the selection. 
  284.  
  285.  
  286. ΓòÉΓòÉΓòÉ 4.4. Activation Behavior ΓòÉΓòÉΓòÉ
  287.  
  288. Use the Activation Behavior radio buttons to select the behavior of the KwikINF 
  289. window. The KwikINF window can be displayed or bypassed when the user presses 
  290. the KwikINF hot key after KwikINF has been installed. 
  291.  
  292. o Select the Display KwikINF Window radio button to tell KwikINF that you 
  293.   always want the KwikINF window to be displayed when you press the KwikINF hot 
  294.   key to initiate searches for information.  This is the default behavior of 
  295.   the KwikINF window. 
  296.  
  297.   When the you press the KwikINF hot key, you can initiate a search for the 
  298.   text string that may be automatically displayed in the Search String entry 
  299.   field or for the text string that you enter into this field. You can also 
  300.   specify which online document in the BOOKSHELF KwikINF searches for the text 
  301.   string. 
  302.  
  303. o Select the Bypass KwikINF Window radio button to tell KwikINF that you do not 
  304.   want the KwikINF window to be displayed when you press the KwikINF hot key to 
  305.   initiate searches for information. This is typically used when working under 
  306.   conditions where the KwikINF automatic text-retrieval feature is available. 
  307.  
  308.   When you press the KwikINF hot key, KwikINF automatically looks for the text 
  309.   string under the cursor in the online document that has a matching entry in 
  310.   the KwikINF index file or, if there is no matching entry in the index file, 
  311.   in the Default volume selected from the Configure KwikINF window. 
  312.  
  313.   You configure KwikINF by pressing the Configure push button in the KwikINF 
  314.   window.  To configure KwikINF when this window is bypassed, press SHIFT + 
  315.   your KwikINF hotkey to display the Configure KwikINF window. 
  316.  
  317.  
  318. ΓòÉΓòÉΓòÉ 5. Searching for information using the KwikINF window ΓòÉΓòÉΓòÉ
  319.  
  320. If you have configured KwikINF to display the KwikINF window (this is the 
  321. default condition), the KwikINF window is displayed when you press your KwikINF 
  322. hot key. 
  323.  
  324. The KwikINF window allows you to search for a text string in an online document 
  325. in the OS/2 BOOKSHELF.  The text string is typed by you in the Search String 
  326. entry field or is automatically retrieved by KwikINF, under certain conditions, 
  327. from under the cursor when you press your KwikINF hot key. 
  328.  
  329. The online document that KwikINF searches for the text string is selected from 
  330. the Volume to Search list box by KwikINF or by you.  KwikINF selects the Volume 
  331. to Search by looking for the text string that has a matching entry in the 
  332. KwikINF index file or, if there is no matching entry in the index file, in the 
  333. Default Volume you have selected in the Configure KwikINF window.  Or you can 
  334. override KwikINF's selection of the Volume to Search by making your own 
  335. selection from the list box. 
  336.  
  337. To initiate the search for the text string in the online document, press the 
  338. Search push button or press Enter. If the search is successful, KwikINF opens 
  339. the online document to the online panel that contains the information and 
  340. displays a window with a title bar that matches the search string. 
  341.  
  342. If the search is not successful, you can search any online document for the 
  343. information by following this procedure: 
  344.  
  345. o Clear the Search String entry field. 
  346. o Select an online document from the Volume to Search list box.  The Contents 
  347.   window of the online document appears. 
  348. o Select Services from the menu bar. 
  349. o Select Searchfrom the Services pull down menu.  The Search help window 
  350.   appears. 
  351. o Type the text string, then select the All libraries radio button. 
  352. o Select the Search push button or press Enter. 
  353.  
  354. Use the push buttons on the KwikINF window as follows: 
  355.  
  356. o Press Search to initiate the search for the text string in the Search String 
  357.   entry field in the selected online document. 
  358. o Press Cancel to cancel the request to search for the text string and to close 
  359.   the KwikINF window. 
  360. o Press Configure to display the Configure KwikINF window. 
  361. o Press Help to get general help for the current window. 
  362.  
  363.  
  364. ΓòÉΓòÉΓòÉ 5.1. Search String entry field ΓòÉΓòÉΓòÉ
  365.  
  366. KwikINF searches for the text string in this entry field in the selected online 
  367. document in the OS/2 BOOKSHELF. 
  368.  
  369. Under certain conditions, KwikINF automatically retrieves the word under the 
  370. cursor when you press your KwikINF hot key. Letters, numbers, underscores, and 
  371. the pound sign are retrievable by KwikINF. Blank spaces and other special 
  372. characters are used as delimiters and are not retrievable by KwikINF. 
  373.  
  374. You may also type any text string you want into this field.  All characters are 
  375. valid in the entry field to allow for special search criteria. 
  376.  
  377.  
  378. ΓòÉΓòÉΓòÉ 5.2. Volume to Search list box ΓòÉΓòÉΓòÉ
  379.  
  380. The KwikINF window includes a list box of all online documents stored in the 
  381. OS/2 BOOKSHELF subdirectories.  KwikINF initiates searches for information in 
  382. any online document in this list.  The online document where KwikINF looks for 
  383. the Search String is selected from the Volume to Search list box by KwikINF or 
  384. by you.  KwikINF selects the Volume to Search by looking for the text string 
  385. that has a matching entry in the KwikINF index file or, if there is no matching 
  386. entry in the index file, in the Default Volume you have selected in the 
  387. Configure KwikINF window.  Or you can override KwikINF's selection of the 
  388. Volume to Search by making your own selection from the list box. 
  389.  
  390. You can also open and display the Contents of an online document by 
  391. double-clicking on an entry in this list box. 
  392.  
  393.  
  394. ΓòÉΓòÉΓòÉ <hidden> IBM Trademark ΓòÉΓòÉΓòÉ
  395.  
  396. Trademark of the IBM Corporation. 
  397.  
  398.  
  399. ΓòÉΓòÉΓòÉ <hidden> KwikINF Keys Help ΓòÉΓòÉΓòÉ
  400.  
  401. Use your KwikINF hot key (ALT+Q or the hot key you select from the Configure 
  402. KwikINF window) to display the KwikINF window.  You can also use your KwikINF 
  403. hot key to initiate a search for a text string automatically, when you 
  404. configure KwikINF to bypass the KwikINF window. 
  405.  
  406. To re-configure KwikINF, when you have configured KwikINF to bypass the KwikINF 
  407. window, press SHIFT + your KwikINF hot key. 
  408.  
  409. To determine what your KwikINF hot key is, double-click on the KwikINF program 
  410. object in the OS/2 Toolkit Information folder.