home *** CD-ROM | disk | FTP | other *** search
-
- ΓòÉΓòÉΓòÉ 1. KwikINF Overview ΓòÉΓòÉΓòÉ
-
- KwikINF provides a quick and convenient method of accessing help information in
- OS/2* 2.0 online documents. Once KwikINF has been started, pressing a hot-key
- sequence causes the program to pop up and search for a text string of your
- choice.
-
- KwikINF searches the subdirectories specified in the BOOKSHELF environment
- variable for online documents. BOOKSHELF is an environmental variable, set in
- CONFIG.SYS, that contains a list of subdirectories containing online documents.
-
- The hot-key, which can be redefined, activates a Search window that lets you
- specify the string KwikINF is to search for. Under certain circumstances,
- KwikINF can automatically retrieve the word at the current cursor position and
- place it in the entry field of the Search window. This text retrieval feature
- is active in OS/2* full-screen and Presentation Manager (PM) multi-line entry
- (MLE) fields. The text retrieval feature is not active in PM windows, AVIO
- windows, DOS windows, or WINOS2 windows.
-
- The hot-key activation is not available in DOS or WINOS2 full screen sessions.
-
- Once the desired help text is displayed, the user can toggle back to the
- calling editor or application by pressing the hot-key sequence again.
-
- The files required for using KwikINF are installed with the Developer's Toolkit
- for OS/2* 2.0.
-
-
- ΓòÉΓòÉΓòÉ 2. Using KwikINF ΓòÉΓòÉΓòÉ
-
- Pressing the hot-key sequence brings to the foreground KwikINF's Search window.
-
- KwikINF will work in any of the OS/2 sessions types: full screen, AVIO
- window, and PM window. If your application is running in a full-screen session
- or an active PM window is a multi-line entry (MLE) field, KwikINF will retreive
- the word the cursor is on and automatically place it in the entry field of the
- Search window. In PM and AVIO windows, the user may use the hot-key sequence to
- display the search window; however, you must enter the search string manually.
- KwikINF does not pre-fill the search string field for PM and AVIO windows.
- KwikINF cannot determine the word under the cursor in these types of sessions
- because they are graphics sessions and the characters are stored as bit maps
- rather than as characters.
-
- To find information on a string, take the following steps:
-
- o If you are in a full-screen session or MLE window, position the cursor on the
- string you want to search for, then press the hot-key sequence. KwikINF
- retrieves the word at the cursor and places it in the entry field of the
- Search window.
-
- o If you are in a PM window or an AVIO session, press the hot-key sequence,
- then type the word to search for in the entry field of the Search window.
-
- KwikINF then takes you to the entry for the search string in the online
- document.
-
-
- ΓòÉΓòÉΓòÉ 3. Command Line Options ΓòÉΓòÉΓòÉ
-
- You can specify three KwikINF options from the command line. An example of the
- command line syntax follows:
-
- KwikINF [/C] [/T] [/?]
-
- where:
-
- KwikINF
- entering KwikINF at the command prompt with no options specified will start
- KwikINF. After entering this command, the default hot-key sequence (ALT + Q)
- is enabled.
-
- /T
- entering the /T option will terminate KwikINF and disable the hot-key
- sequence. KwikINF will be terminated for all active sessions.
-
- /C
- entering the /C option will display the Configure KwikINF window. Use the
- Configure KwikINF window to customize KwikINF values.
-
- /?
- entering the /? will display the following information.
-
- Usage: KwikINF [Option]
- Option Description
- /C Configure KwikINF
- /T Terminate KwikINF
- /? This short help list
-
-
- ΓòÉΓòÉΓòÉ 4. Help for Configure KwikINF ΓòÉΓòÉΓòÉ
-
- The Configure KwikINF window contains fields that enable you to:
-
- o Activate the hot-key of your choice
- o Monitor 1 to 12 OS/2* full-screen sessions
- o Specify the name of online document KwikINF searches by default
- o Indicate the type of search mode.
-
- Push Buttons
-
- o Select the OK push button to activate all changes.
- o Select the Cancel push button to cancel a search request and minimize KwikINF
- to a unique icon.
- o Select the Help push button to get general help for the current window.
-
-
- ΓòÉΓòÉΓòÉ 4.1. Activation Key Sequence ΓòÉΓòÉΓòÉ
-
- The Activation Key Sequence selection provides a list of available hot-key
- combinations. To access the list, single-click on the down arrow, Select the
- key combination that activates the command line KwikINF search mechanism. This
- key combination also lets you obtain instant access to information in each of
- the Toolkit online documents.
-
- Valid key combinations
-
- CTRL + A
- CTRL + H
- CTRL + Q
- ALT + A
- ALT + Q
-
- To find information, position the cursor at the end of the text string you want
- KwikINF to find and press Alt + Q (or whatever hot-key combination you selected
- from the list).
-
-
- ΓòÉΓòÉΓòÉ 4.2. Full Screen Sessions ΓòÉΓòÉΓòÉ
-
- Use the Number of Fullscreen Sessions to Monitor spin button to set the number
- of OS/2* full-screen sessions that KwikINF monitors. The term monitor means
- that KwikINF enables the search mechanism, and controls system resources of all
- OS/2 full-screen sessions up to the number specified here.
-
-
- ΓòÉΓòÉΓòÉ 4.3. Default Volume to Search ΓòÉΓòÉΓòÉ
-
- Use the Default Volume to Search single selection list box to specify which
- online document you want KwikINF to search by default. Select the online
- document, then select the OK push button to activate the selection.
-
- The online documents presented in this list are found in the subdirectories
- specified in the BOOKSHELF environment variable in CONFIG.SYS. To make other
- online documents available to KwikINF, add their directory location to the
- BOOKSHELF environment variable.
-
-
- ΓòÉΓòÉΓòÉ 4.4. Activation Behavior ΓòÉΓòÉΓòÉ
-
- Use the radio buttons in the Activation Behavior section to select a mode of
- operation. KwikINF starts the mode of operation when you type a text string
- from an OS/2* command line or position the cursor at the end of a text string
- in your program.
-
- o Select the Display Search Window radio button to tell KwikINF that you always
- want searches performed through the Search Window.
-
- o Select the Default Search radio button to tell KwikINF that you want to
- bypass the Search Window and go directly to the online document.
-
- o To bring up the Configuration Window while in bypass mode, press the SHIFT +
- hot-key sequence the user has selected.
-
-
- ΓòÉΓòÉΓòÉ 5. Help for Search Window ΓòÉΓòÉΓòÉ
-
- Make sure you type the text string in the Search String entry field. Select
- the online document, then select the Search push button or press Enter. If the
- search is successful, KwikINF displays a window with a title bar that matches
- the search string.
-
- If the search is not successful, you can search all online documents by
- following this procedure:
-
- o Clear the Search String entry field.
- o Select an online document. The Contents window of the online document
- appears.
- o Select Services from the menu bar.
- o Select Search. The Search window appears.
- o Type the text string, then select the All libraries radio button.
- o Select the Search push button or press Enter.
-
- Note: If you have configured KwikINF to always display the Search Window, then
- the window will appear after you type a text string and press Alt + Q at
- the command line. When the search is complete, KwikINF highlights the
- online document that contains the first occurrence of the search string.
- Select the Search push button or press Enter to display a window with a
- title bar that matches the search string.
-
- Push Buttons
-
- o Select the Search push button to find the text string in the Search String
- entry field.
- o Select the Cancel push button to cancel a search request and minimize KwikINF
- to a unique icon.
- o Select the Configuration push button to display the Configure KwikINF window.
- o Select the Help push button to get general help for the current window.
-
-
- ΓòÉΓòÉΓòÉ 5.1. Search String field ΓòÉΓòÉΓòÉ
-
- Use the Search String entry field to enter the text string that you want
- KwikINF to find. You may type any text string you want into this field. All
- characters are valid in the entry field to allow for special search criteria.
- The search string field is automatically filled for you if you press the
- hot-key sequence during an editor session. KwikINF uses some special rules in
- pre-filling the search string field. The allowable characters are letters,
- numbers, underscores, and the pound sign. Blank spaces and other special
- characters are used as delimiters and not in pre-filling of the search string
- field. You may override this by first selecting the desired text and then
- pressing the hot-key sequence. Using this method, you can pre-fill the search
- string field with special characters.
-
-
- ΓòÉΓòÉΓòÉ 5.2. Volume to Search ΓòÉΓòÉΓòÉ
-
- Use the Volume to Search single selection list box to specify which online
- document you want KwikINF to search.
-
- The online documents presented in this list are found in the subdirectories
- specified in the BOOKSHELF environment variable in CONFIG.SYS. To make other
- online documents available to KwikINF, add their directory location to the
- BOOKSHELF environment variable.
-
-
- ΓòÉΓòÉΓòÉ 6. Error Messages ΓòÉΓòÉΓòÉ
-
- Entering an invalid option parameter on the command line is detected as an
- error. The following message is displayed:
-
- ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
- Γöé Invalid Command-Line argument found Γöé
- ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
-
- If KwikINF is not running and an attempt is made to configure it by using the
- command line, the following message is displayed:
-
- ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
- Γöé KwikINF Not Installed Γöé
- Γöé /? for Option List Γöé
- ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
-
-
- ΓòÉΓòÉΓòÉ <hidden> IBM Trademark ΓòÉΓòÉΓòÉ
-
- Trademark of the IBM Corporation.
-
-
- ΓòÉΓòÉΓòÉ <hidden> KwikINF Keys Help ΓòÉΓòÉΓòÉ
-
- Use the configured hot-key sequence to activate the search window.
-
- To bring up the Configuration Window while in bypass mode, press the SHIFT +
- hot-key sequence the user has selected.