home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ipfe10.zip / IPFEDOC.INF (.txt) < prev    next >
OS/2 Help File  |  1993-08-14  |  94KB  |  2,304 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. IPF Editor Overview ΓòÉΓòÉΓòÉ
  3.  
  4. Welcome to the IPF Editor, the easiest to use and most powerful editor designed 
  5. specifically for creating both online documentation and online help files for 
  6. your applications. 
  7.  
  8. There are currently two versions of the IPF Editor available.  The first is a 
  9. 15-usage trial version with some options disabled.  The second is a registered 
  10. version that must be purchased from PCS and includes many more features, 
  11. customer support, updates, a complete tutorial, samples, and much more! 
  12.  
  13. The IPF Editor IPF Commands menu provides you with a large variety of IPF tags 
  14. to choose from.  Some commands require you to mark text (highlight it) before 
  15. selecting the command. 
  16.  
  17. All IPF Commands are available from the IPF Editor's IPF Commands menu.  If an 
  18. IPF command is not available (it is "grayed out") it is because it requires 
  19. marked text to operate correctly.  You can use the mouse to mark the desired 
  20. text, then select the tagging command you want to apply to the marked text. 
  21.  
  22.  
  23. ΓòÉΓòÉΓòÉ 1.1. Software Requirements ΓòÉΓòÉΓòÉ
  24.  
  25. The IPF Editor is a 32-bit OS/2 2.x application and requires OS/2 2.0, 2.01, or 
  26. 2.1. The IPF tagged files it generates may be used with any OS/2 application 
  27. (1.x or 2.x). 
  28.  
  29. To make full use of the IPF Editor you will need to have either the IBM OS/2 
  30. 2.0 or 2.1 Toolkit (which contains the IPF Compiler) or a compatible product. 
  31.  
  32. There is a problem with the OS/2 2.01 Service Pack version of Trident video 
  33. drivers. Dragging dialog boxes across the IPF Editor screen can cause a 
  34. protection error in PMWIN.DLL and stop the program.  THIS IS NOT DIRECTLY 
  35. SOLVABLE, so if you are using the 2.01 service pack in SVGA modes, don't drag 
  36. dialog boxes across your IPF Editor screens! 
  37.  
  38.  
  39. ΓòÉΓòÉΓòÉ 1.2. Registration ΓòÉΓòÉΓòÉ
  40.  
  41. The IPF Editor is both a shareware and commercial product.  The shareware 
  42. version  gives you a fifteen usage trial period to try out the product.  If 
  43. after trying it you find it of value register it and receive the full package 
  44. which provides automatic online-help generation for use with any C-based or C++ 
  45. based OS/2 2.x application you are building.   You may register it by  filling 
  46. out the registration/order card and sending $95.00 U.S. to Perez Computing 
  47. Services at the address written below.  Washington state residents add 7.8% 
  48. sales tax.  Please use the provide form in file: IPFEDIT.REG when ordering. 
  49. Sorry, no VISA or MASTERCARD orders, please. 
  50.  
  51.      Compuserve: 70410, 2416
  52.      Prodigy: GFKM03A
  53.  
  54.      Perez Computing Services
  55.      4725 Monte Vista Pl.
  56.      Mount Vernon, WA 98273
  57.  
  58.  
  59. ΓòÉΓòÉΓòÉ 1.3. Copyright and Notices ΓòÉΓòÉΓòÉ
  60.  
  61. The IPF Editor is Copyright (C) 1992-1993 Perez Computing Services. 
  62.  
  63.  
  64. ΓòÉΓòÉΓòÉ 1.4. Reporting Problems ΓòÉΓòÉΓòÉ
  65.  
  66. The IPF Editor has been thoroughly tested over the last year but occasionally 
  67. bugs or  problems are reported. If you find a problem, or have a suggestion for 
  68. a new feature, please contact PCS, attention Bill Perez,  either through 
  69. Compuserve, Prodigy, or the U.S. mail. 
  70.  
  71.  
  72. ΓòÉΓòÉΓòÉ 2. Using the IPF Editor ΓòÉΓòÉΓòÉ
  73.  
  74. The IPF Editor display is broken up into several sections as shown in the 
  75. figure below: 
  76.  
  77. The IPF Editor supports all standard OS/2 editing commands (Marking text, 
  78. copying, cutting, deleting marked text, pasting text into the document from the 
  79. clipboard,  undo, etc.).  The arrow keys move the cursor in the editing window. 
  80.  
  81. The IPF Editor also has a second window that will show you the results of using 
  82. the IPF Compiler.  It looks similar to the following: 
  83.  
  84. For more detail on compiling files see the "Compiler Setup" section of this 
  85. reference. 
  86.  
  87.  
  88. ΓòÉΓòÉΓòÉ 2.1. IPF File OverView ΓòÉΓòÉΓòÉ
  89.  
  90. IPF Files are text files that are "tagged" with special commands that are 
  91. recognized by the IBM IPF Compiler.  The IPF Compiler then generates either 
  92. .HLP or .INF files that may be used with applications (.HLP files) or the OS/2 
  93. VIEW.EXE program (.INF files). 
  94.  
  95. IPF files are created by generating panels.  A panel is a section of text that 
  96. will be grouped together and placed in one window when it is displayed by 
  97. either the help manager in your application or the VIEW program supplied with 
  98. OS/2.  Each panel has a title which is displayed at the top of the window 
  99. containing the text. 
  100.  
  101. You are currently looking at the panel titled "IPF File OverView."  Each panel 
  102. will also be placed in the table of contents for the document. 
  103.  
  104. You can split your document into several different files, each with specific 
  105. panels, and group the entire document together using the IPF Editor's "File 
  106. Create Project" command. 
  107.  
  108.  
  109. ΓòÉΓòÉΓòÉ 2.2. Graphical Tool Menu ΓòÉΓòÉΓòÉ
  110.  
  111. The graphical tool menu at the right side of the IPF Editor window provides you 
  112. with several tools to quickly edit documents.  If the graphical menu doesn't 
  113. completely fit in your current window, you can use the scroll bar at the right 
  114. side of the IPF Editor window to view the rest of it. 
  115.  
  116. You may disable the graphical menu to increase the size of the editing window 
  117. using the "Options, Show Graphical Menu" option. 
  118.  
  119. The following options are available in the graphical menu: 
  120.  
  121. The  lets you define heading level one tags (just as if you had used the IPF 
  122. commands, Panel Headers 1 menu option). 
  123.  
  124. The  lets you define heading level two tags (just as if you had used the IPF 
  125. commands, Panel Headers 2 menu option). 
  126.  
  127. The  lets you define heading level three tags (just as if you had used the IPF 
  128. commands, Panel Headers 3 menu option). 
  129.  
  130. The  lets you insert a paragraph marker at the current location.  This is the 
  131. same as pressing the right mouse button and releasing it while the "Paragraph" 
  132. menu option is highlighted, or using the IPF commands, paragraph option. 
  133.  
  134. The  lets you mark a section of text as a table. 
  135.  
  136. The  lets you insert artwork (OS/2 bitmaps or OS/2 metafiles)  into your 
  137. document. 
  138.  
  139. The  lets you insert a note into your document. 
  140.  
  141. The  lets you define a footnote link in your document. 
  142.  
  143. The  lets you mark an area of text as a simple list. 
  144.  
  145. The  lets you mark an area of text as an ordered list. 
  146.  
  147. The  lets you mark an area of text as an unordered list. 
  148.  
  149. The  lets you create an index entry. 
  150.  
  151. The  lets you mark a selection of text as a "CAUTION:" statement. 
  152.  
  153. The  lets you mark a selection of text as a "WARNING:" statement. 
  154.  
  155. The  lets you insert a symbol into your document at the current location. 
  156.  
  157. The  lets you mark selected text as being aligned left or right. 
  158.  
  159. The  lets you setup the push button controls located at the bottom of the help 
  160. or VIEW window. 
  161.  
  162. The  lets you generate hyperlinks to other portions of your document. 
  163.  
  164. The  allows you to save the current file to disk. 
  165.  
  166. The  lets you save a new file to disk (it lets you give it a new name). 
  167.  
  168. The  lets you select a project file to work on. 
  169.  
  170. The  lets you compile the current file or project. 
  171.  
  172. The  lets you locate text in your document. 
  173.  
  174.  
  175. ΓòÉΓòÉΓòÉ 2.3. Creating Online Documents Overview ΓòÉΓòÉΓòÉ
  176.  
  177. To create on online document perform the following steps: 
  178.  
  179. o Enter all text that you wish to include in your document, or import text from 
  180.   a word processor. 
  181.  
  182. o Mark the document using the standard IPF commands available in the IPF Editor 
  183.   or enter them manually if they are available in the IPF Guide but not 
  184.   directly supported by the IPF Editor.  You do not need to manually enter 
  185.   hypertext/graphics links at this time. 
  186.  
  187. o Create a project by selecting the files to be included in your document using 
  188.   the Create Project.  All files must be in the same directory.  Be sure to 
  189.   sort the files in the order you want to see their panel headers show up in 
  190.   the file's table of contents.  Generally this isn't a consideration for 
  191.   online help projects but it is very important for online documents. 
  192.  
  193.   Use the Compiler Compile Project option to generate your online document. If 
  194.   any errors are detected double click with the left mouse button on the error 
  195.   shown in the Compiler Results window.  This takes you to the error in the IPF 
  196.   file. Fix the error, then compile again until no errors are detected. 
  197.  
  198. o Once all errors are corrected test your online document using the Compiler 
  199.   Test Document option. 
  200.  
  201. o When the document is correct use the "Application Generate 
  202.   Auto-hypertext/graphics link" menu to automatically create hypertext/graphics 
  203.   links for all panel headers in your document. 
  204.  
  205. o Test your document for accuracy and verify the compile took place with no 
  206.   errors. 
  207.  
  208. That's all you have to know to create an online document! 
  209.  
  210.  
  211. ΓòÉΓòÉΓòÉ 2.4. Creating Online Help Files Overview ΓòÉΓòÉΓòÉ
  212.  
  213. To create on online help files perform the following steps: 
  214.  
  215. Create an online help project selecting the "File Create Project" option.  Then 
  216. scan the resource files associated with your application using the "Generate 
  217. Panels from RC" files option. Several files will automatically be created for 
  218. you containing panel headers for menus, submenus, menu items, dialog boxes, and 
  219. dialog box items.  Be sure to select the "online help" radio button to select 
  220. the type of project you are creating. 
  221.  
  222. o Mark the IPF files using the standard IPF commands available in the IPF 
  223.   Editor or enter them manually if they are available in the IPF Guide but not 
  224.   directly supported by the IPF Editor.  You do not need to manually enter 
  225.   hypertext/graphics links at this time. Or ever. 
  226.  
  227.   Use the "Compiler Compile Project" option to generate your online help file. 
  228.   If any errors are detected double click with the left mouse button on the 
  229.   error shown in the Compiler Results window.  This will take you directly to 
  230.   the place where the error was reported. Fix the error, then compile again 
  231.   until no errors are detected. 
  232.  
  233. o Use the "Application Create help resource tables" to create the help resource 
  234.   tables (a .RC file), a C include file (.H), and the C functions needed to 
  235.   initialize and call the help manager (in a .C file). 
  236.  
  237. o Include the help resource file created by the IPF Editor in your 
  238.   application's resource file using the "rcinclude" command (part of the 
  239.   resource script language).  Then compile your application. Also compile and 
  240.   link the C file into your application.  Use the "HelpInit()" function to 
  241.   initialize the help system.  Call "HelpProcessMessages" when your application 
  242.   processes the WM_ACTIVATE, WM_INITMENU, and WM_COMMAND messages.  Finally, 
  243.   call "HelpDestroy" before terminating your application. 
  244.  
  245. o When the document is correct use the "Application Generate 
  246.   Auto-hypertext/graphics link" menu to automatically create hypertext/graphics 
  247.   links for all panel headers in your document. 
  248.  
  249. o Test your document for accuracy and verify the compile took place with no 
  250.   errors.  Test each entry in your application by pressing F1 on each item and 
  251.   verifying the correct help is displayed. 
  252.  
  253. For more detail see Online Help Generation. 
  254.  
  255.  
  256. ΓòÉΓòÉΓòÉ 2.5. Project File Selection ΓòÉΓòÉΓòÉ
  257.  
  258. If you select a project file (using 'File Select Project') you will see file 
  259. icons below the main editing window.  You can select any file in the project by 
  260. clicking on the desired file icon.  If there are more files in your project 
  261. than can be shown in the current space available in the window, use the scroll 
  262. bar at the bottom of the IPF Editor window to scroll the file icons left or 
  263. right. 
  264.  
  265. You can create a project file using the "File Create Project" menu option. 
  266. Using projects greatly facilitates generation of online documents and 
  267. applicaton help. 
  268.  
  269.  
  270. ΓòÉΓòÉΓòÉ 2.6. Source File Size Limitations ΓòÉΓòÉΓòÉ
  271.  
  272. There is a 60,000 byte limit to each source file that may be edited in the IPF 
  273. Editor.  You can create larger documents by using the project option and 
  274. creating multiple source files (usually one per chapter/section).  The IPF 
  275. Editor limits you to 60,000 bytes when loading or importing files so that you 
  276. will never exceed the 64K limit on a source file imposed by the IBM IPF 
  277. Compiler. 
  278.  
  279.  
  280. ΓòÉΓòÉΓòÉ 3. Generating Online Document Files ΓòÉΓòÉΓòÉ
  281.  
  282. The IPF Editor makes creating online documents very simple.  You can create 
  283. basic online documents by just typing in the text, creating a few panel 
  284. headers, and compiling the file.  Larger documents can also be written by 
  285. creating a project and building panels, hypertext/graphics links, indices, etc. 
  286.  
  287. To create on online document perform the following steps: 
  288.  
  289. o Enter all text that you wish to include in your document, or import text from 
  290.   a word processor.  Create panels as you enter the text or go back and insert 
  291.   panel headers if you imported text. 
  292.  
  293. o Mark the document using the standard IPF commands available in the IPF Editor 
  294.   or enter them manually if they are available in the IPF Guide but not 
  295.   directly supported by the IPF Editor. 
  296.  
  297. o Create a project by selecting the files to include in your document using the 
  298.   "Create Project."  All files must be in the same directory. 
  299.  
  300.   Use the "Compile Project" option to generate your online document.  If any 
  301.   errors are detected double click with the left mouse button on the error 
  302.   shown in the "Compiler Results" window.  Fix the error, then compile again 
  303.   until no errors are detected. 
  304.  
  305. o Once all errors are corrected test your online document using the "Compiler 
  306.   Test Document" option. 
  307.  
  308. o When the document is correct use the "Application Generate 
  309.   Auto-hypertext/graphics link" menu to create hypertext/graphics links 
  310.   automatically for all panel headers in your document. 
  311.  
  312. Note:  Be sure to sort the files in the order you want to see their respective 
  313.        panel headers show up in the file's table of contents.  Generally this 
  314.        isn't a consideration for online help projects but it is very important 
  315.        for online documents. 
  316.  
  317.  
  318. ΓòÉΓòÉΓòÉ 3.1. Creating Online Documentation Panels ΓòÉΓòÉΓòÉ
  319.  
  320. Creating panels can be done in several different ways.  You can create panels 
  321. that have tag resource identifiers, tag names, and/or tag ID's.  Which method 
  322. you use often is based on what type of document you are creating and what 
  323. information you have when you are creating the panel. 
  324.  
  325. When you are creating Online Document panels you do not need to include a tag 
  326. res, name, or ID value unless you wish to hyperlink some text to the panel. 
  327.  
  328. If you want to allow hyperlinking to the panel you are creating you will need 
  329. to supply a tag res code. You can force the requirement of tag res codes by 
  330. setting the "Option Require Tag Res" menu option on. 
  331.  
  332. Follow these steps to create a panel (including it's panel header): 
  333.  
  334. o Enter a title for the panel (A maximum of 32 characters is allowed). 
  335.  
  336. o On the following line use the :p. (paragraph) tag by pressing <ALT>-<P>. 
  337.   Then enter the text you want to place in this panel.  You can place as many 
  338.   paragraphs, tables, pictures, or other tags as you want into the panel. 
  339.  
  340. o Now mark (highlight) the panel's title and select the panel header level you 
  341.   wish to create.  Panel headers 1 through 4 are "hyperlinkable" from 
  342.   hypertext/graphics tags. 
  343.  
  344. o Enter a tag res code (if you have that option enabled).  You can use the 
  345.   default value supplied (which will automatically be incremented each time you 
  346.   create a panel definition). 
  347.  
  348.  
  349. ΓòÉΓòÉΓòÉ 4. Generating Application Online Help Files ΓòÉΓòÉΓòÉ
  350.  
  351. Creating an online help file requires you to correctly tag all panel headers, 
  352. compile the IPF files (creating a .HLP file), and add resource statements and C 
  353. function calls to your application. 
  354.  
  355. Generating the resource, C source, and include files needed to add online help 
  356. to your C application is easily accomplished using the "Application Create Help 
  357. Resource Tables" option. It prompts you to select the source resource and 
  358. include files, decide on names for the output files.  When you have completed 
  359. your selections, it generates your resource help table file, include file, and 
  360. C source files. 
  361.  
  362. Note:  You must also have a 32 bit C Compiler such IBM's C Set/2, C Set ++ and 
  363. the resource compiler included with the IBM OS/2 2.x Toolkit. 
  364.  
  365.  
  366. ΓòÉΓòÉΓòÉ 4.1. Creating Online Help File Panels ΓòÉΓòÉΓòÉ
  367.  
  368. Each panel in an online help file must have a panel header.  The panel header 
  369. is created using the panel header menu command.  There are six level's of panel 
  370. headers, but only the top four (1-4) are supported by the hypertext/graphics 
  371. linking commands. 
  372.  
  373. Each panel header in an online help file requires a tag resource number.  You 
  374. must enable the "Options Require Tag Res" menu option to force this resource 
  375. number generation.  You may also wish to generate tag names for each panel. 
  376. This makes it easier to keep track of panel names when creating 
  377. hypertext/graphics links and other operations performed on panel headers. 
  378.  
  379. Each panel's tag resource number must match the resource identifier for the 
  380. menu item, dialog item, etc. in your application. 
  381.  
  382. Panel definition is made much easier by using the "Application Load definition 
  383. include file" option. This scans the your application's include files, 
  384. searching for "#defines". Once the files have been read, every time you create 
  385. a new panel header (the title of the panel) a list of #defines will be 
  386. presented. This permits you to select the tag res number that will be set to 
  387. the resource ID number from the #define definition.  If you've turned on the 
  388. tag name option the #define label will automatically be used to create a 
  389. "PANEL_<label>" tag name for the panel header. 
  390.  
  391. Then insert the ":p." (paragraph, with <ALT>-<P>) command on the line 
  392. immediately following the panel header line and begin typing the description of 
  393. the applications menu, menu item, dialog, or dialog item. 
  394.  
  395. Note:  General Help Creation You must define a main panel header and text to 
  396.        enable the general help (the help you get by just pressing F1 with no 
  397.        menu or dialog item selected).  This very is easily done by using the 
  398.        automatically defined PANEL_MAIN for the general information panel of 
  399.        your online help. To automatically generate this panel, you must first 
  400.        have turned on the "require tag res" option, 
  401.  
  402.  
  403. ΓòÉΓòÉΓòÉ 4.2. Generating Resource and C Help Files ΓòÉΓòÉΓòÉ
  404.  
  405. To generate the online help file from the IPF files you have entered and tagged 
  406. you will need to perform the following steps: 
  407.  
  408. When you select the "Application Create Help Resource Files" option for the 
  409. first time in a project the IPF Editor will require that you fill out the name 
  410. of an include file to use as the basis for generating panel definitions (if you 
  411. haven't already selected one using the "Application Load Definition Include 
  412. File (typically this is the include file containing your C #define statements 
  413. used when you defined your menus and dialogs).  You will also need to specify 
  414. the resource file to scan containing the menu and dialog items for which help 
  415. is being generated (you can specify the primary resource file which contains 
  416. "rcinclude" statements to include other resource files). 
  417.  
  418. You will also need to determine the file names for the files the IPF Editor is 
  419. going to create for you. You will need to specify names for the following: 
  420.  
  421.    - Panel Include File 
  422.  
  423.      This is the file that will contain all of the #define's required to 
  424.      compile the help resource tables created by the IPF Editor.  This should 
  425.      not be the same as any of the include files your application already uses 
  426.      since this procedure will overwrite whatever file name you specify here. 
  427.  
  428.    - Help Resource File 
  429.  
  430.      This is the resource file (.RC) that will be created by the IPF Editor. 
  431.      It will create the required help resource statements to support the online 
  432.      help in your application. 
  433.  
  434.    - C Source File 
  435.  
  436.      This is the C Source file that will contain the standard C functions your 
  437.      application will call to completely enable the online help.  This file 
  438.      should not be the same as any of the C files used for creation of your 
  439.      application since the IPF Editor will overwrite this every time this 
  440.      option is selected. 
  441.  
  442. The IPF Editor will now attempt to scan the main resource files for your 
  443. application.  It will read the menu, dialog, and dialog control statements and 
  444. extract the definition labels for each control.  If you are building help for a 
  445. large project you'll probably want to create a separate directory and copy all 
  446. of the resource files and include files from each module into it. 
  447.  
  448. The IPF Editor will ask you for the application resource ID value (the value 
  449. assigned to the applications menu, accelerator table, or icon statements in the 
  450. resource file) if it is unable to find a MENU table to extract it from in the 
  451. first resource file scanned.  Just select the appropriate ID value from the 
  452. list displayed and that  value will be used to create the help resource tables. 
  453.  
  454.  
  455. ΓòÉΓòÉΓòÉ 4.3. C Functions Created ΓòÉΓòÉΓòÉ
  456.  
  457. The IPF Editor creates the following C functions to help you add online help to 
  458. your applications: 
  459.  
  460. o HelpInit 
  461.  
  462.   Call this after you have created your main window for your application.  This 
  463.   will activate the help system with your applications help files. 
  464.  
  465. o HelpDestroyInstance 
  466.  
  467.   This will remove the help system and should be called before you exit your 
  468.   program.  If you do not call this before exiting OS/2 will automatically 
  469.   deassociate the help instance from your application (since your application 
  470.   no longer exists). 
  471.  
  472. o HelpProcessMessages 
  473.  
  474.   Call this from your main window function for the following messages: 
  475.  
  476.    - WM_ACTIVATE 
  477.  
  478.    - WM_INITMENU 
  479.  
  480.    - WM_COMMAND 
  481.  
  482.    - HM_ERROR 
  483.  
  484.    - HM_GENERAL_HELP_UNDEFINED 
  485.  
  486.    - HM_HELPSUBITEM_NOT_FOUND 
  487.  
  488. The following table shows the functions generated, their arguments, and their 
  489. purpose: 
  490.  
  491. ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
  492. ΓöéFunction            ΓöéDescription              ΓöéArguments                Γöé
  493. Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  494. ΓöéHelpInit            ΓöéThis intiializes the helpΓöéHWND hwndFrame - Owner ofΓöé
  495. Γöé                    Γöésystem and sets the help Γöéhelp instance.           Γöé
  496. Γöé                    Γöéinstance to your         Γöé                         Γöé
  497. Γöé                    Γöéapplication help         Γöé                         Γöé
  498. Γöé                    Γöédocument.                Γöé                         Γöé
  499. Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  500. ΓöéHelpDestroyInstance ΓöéThis removes the help    ΓöéNo Arguments.            Γöé
  501. Γöé                    Γöéinstance.  This allows   Γöé                         Γöé
  502. Γöé                    Γöéyou to set a new help    Γöé                         Γöé
  503. Γöé                    Γöéinstance or you may call Γöé                         Γöé
  504. Γöé                    Γöéthis before  your programΓöé                         Γöé
  505. Γöé                    Γöéexits.                   Γöé                         Γöé
  506. Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  507. ΓöéHelpProcessMessages ΓöéThis will process        ΓöéHWND hwnd, USHORT msg,   Γöé
  508. Γöé                    ΓöéWM_ACTIVATE, WM_INITMENU,ΓöéMPARAM mp1, MPARAM mp2 - Γöé
  509. Γöé                    Γöéand WM_COMMAND messages  ΓöéStandard window procedureΓöé
  510. Γöé                    Γöéand process help related Γöéarguments.               Γöé
  511. Γöé                    Γöéportions of these        Γöé                         Γöé
  512. Γöé                    Γöémessages.                Γöé                         Γöé
  513. ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
  514.  
  515. Generally you should call the HelpInit after you have created your 
  516. application's main frame window. You can call the HelpDestroyInstance before 
  517. you destroy the frame window.  The HelpProcessMessages  should be called during 
  518. your main window's message processing for the specific messages listed above. 
  519.  
  520.  
  521. ΓòÉΓòÉΓòÉ 4.3.1. C Function Usage Example ΓòÉΓòÉΓòÉ
  522.  
  523. The following shows typical usage of the C functions created by the IPF Editor. 
  524. Your application can use these to initialize and uninitialize the help manager: 
  525.  
  526. int main(int argc, char *argv[], char *envp[])
  527. {
  528.     HAB
  529.         hab;                            // Anchor block
  530.     HMQ
  531.         hmq;                            // Message Queue handle
  532.     PCHAR
  533.         pszClass = "IPFEDEMO";          // Class name
  534.     ULONG
  535.         flFrameFlags =                  // Frame definition
  536.                 FCF_SIZEBORDER | FCF_MENU | FCF_ICON |
  537.                 FCF_TITLEBAR | FCF_SHELLPOSITION | FCF_TASKLIST |
  538.                 FCF_MINMAX;
  539.     QMSG
  540.         qmsg;                           // Message queue contents
  541.  
  542.  
  543.     hab = WinInitialize( 0 );
  544.     hmq = WinCreateMsgQueue( hab, 0 );
  545.  
  546.     // Register our window class
  547.     WinRegisterClass(
  548.         hab,
  549.         pszClass,
  550.         (PFNWP) IPFEDemoWndProc,
  551.         CS_SIZEREDRAW,
  552.         0 );
  553.  
  554.     // Create standard window
  555.     hwndFrame =
  556.         WinCreateStdWindow(
  557.             HWND_DESKTOP,
  558.             WS_VISIBLE,
  559.             &flFrameFlags,
  560.             pszClass,
  561.             "IPF Editor Demo C Program",
  562.             WS_VISIBLE,
  563.             0L,
  564.             IDD_IPFEDEMO,
  565.             &hwndClient );
  566.  
  567.     // Initialize help system
  568.     HelpInit( hwndFrame );
  569.  
  570.     // Loop until terminated
  571.     while( WinGetMsg( hab, &qmsg, 0L, 0, 0 )  )
  572.         WinDispatchMsg( hab, &qmsg );
  573.  
  574.     // Terminate help system
  575.     HelpDestroyInstance();
  576.  
  577.     // Kill window
  578.     WinDestroyWindow( hwndFrame );
  579.  
  580.     // Destroy message queue
  581.     WinDestroyMsgQueue( hmq );
  582.  
  583.     // Kill handle to anchor block
  584.     WinTerminate( hab );
  585.  
  586.     // Exit with error code of zero
  587.     exit( 0 );
  588. }
  589.  
  590. Use the HelpProcessMessages() as shown in the following code fragment: 
  591.  
  592. MRESULT EXPENTRY IPFEDemoWndProc( HWND hwnd, USHORT msg, MPARAM mp1, MPARAM mp2 )
  593. {
  594.     switch( msg )
  595.     {
  596.         // Process messages help needs to be aware of
  597.         case WM_ACTIVATE:
  598.         case WM_INITMENU:
  599.             return HelpProcessMessages( hwnd, msg, mp1, mp2 );
  600.  
  601.         case HM_ERROR:
  602.             DosBeep( 500, 250 );
  603.             DosBeep( 500, 250 );
  604.             return HelpProcessMessages( hwnd, msg, mp1, mp2 );
  605.  
  606.         case HM_HELPSUBITEM_NOT_FOUND:
  607.             DosBeep( 1000, 100 );
  608.             return HelpProcessMessages( hwnd, msg, mp1, mp2 );
  609.  
  610.         case WM_HELP:
  611.             DosBeep( 100, 100 );
  612.             return HelpProcessMessages( hwnd, msg, mp1, mp2 );
  613.  
  614.  
  615.         // Process command messages
  616.         case WM_COMMAND:
  617.             // Make sure help get's chance to see WM_COMMAND message
  618.             HelpProcessMessages( hwnd, msg, mp1, mp2 );
  619.     .
  620.     .
  621.     .
  622. }
  623.  
  624. It's important to note that your application probably would not want to return 
  625. the result of the help access when processing the WM_COMMAND message since it 
  626. will probably want to handle the specific WM_COMMAND message and return it's 
  627. result instead of the generic result used by the help manager. 
  628.  
  629.  
  630. ΓòÉΓòÉΓòÉ 4.4. General rules for using the IPF Editor ΓòÉΓòÉΓòÉ
  631.  
  632. General Rules for easily creating help for your applications: 
  633.  
  634. o Always create all dialog boxes using individual resource ID values. 
  635.  
  636.   Don't create two or more dialog boxes that have controls with the same ID's 
  637.   in them.  Also avoid creating controls or dialogs with resource ID's which 
  638.   are the same as Menu ID's. 
  639.  
  640. o Adding Headers 
  641.  
  642.   If you wish to add headers to a project that has already been loaded always 
  643.   save the file, then reload the project before using the Application Generate 
  644.   Resource Option.  This allows the IPF Editor to accurately scan all files 
  645.   that have been modified before building the help related files. 
  646.  
  647. o Scanning Include Files 
  648.  
  649.   Be sure to scan the include files before trying to add headers as this will 
  650.   automatically create header panel ID's for you.  If you try to generate a 
  651.   header and no panel ID's are are available,  you have not yet scanned an 
  652.   include file. 
  653.  
  654. o Help Menu Items 
  655.  
  656.   The following help menu items are automatically generated in the C source 
  657.   file: 
  658.  
  659.    - IDM_HELP_USING 
  660.  
  661.    - IDM_HELP_INDEX 
  662.  
  663.    - IDM_HELP_CONTENTS 
  664.  
  665.    - IDM_HELP_GENERAL 
  666.  
  667.   The IPF Editor assumes that you have defined each of the above menu items; it 
  668.   uses them without defining them. Code to process these messages is 
  669.   automatically generated; to take advantage of this code you must define them 
  670.   in an include file. You must also create the appropriate menu item statements 
  671.   in your applications menu resource statement.  If you do not want to handle 
  672.   these in your application, comment them out of the C source file generated. 
  673.  
  674. This is what a typical C include file would contain to define the needed menu 
  675. items. 
  676.  
  677. #define IDM_HELP        150
  678. #define IDM_HELP_USING  155
  679. #define IDM_HELP_INDEX  160
  680. #define IDM_HELP_CONTENTS   165
  681. #define IDM_HELP_GENERAL    170
  682.  
  683. This is what a typical resource file would contain to generate a help sub-menu. 
  684.  
  685. SUBMENU "~Help", IDM_HELP
  686. {
  687.     MENUITEM "Help ~index", IDM_HELP_INDEX
  688.     MENUITEM "~General help", IDM_HELP_GENERAL
  689.     MENUITEM "~Using help", IDM_HELP_USING
  690.     MENUITEM "Help ~contents", IDM_HELP_CONTENTS
  691. }
  692.  
  693. Warning: You must define one panel as PANEL_MAIN so that the application can 
  694. correctly initialize the help manager.  The PANEL_MAIN is the general help 
  695. displayed when the user presses F1 with no menu or dialog selected. 
  696.  
  697.  
  698. ΓòÉΓòÉΓòÉ 4.5. Application Create Help Resource Tables Limitations ΓòÉΓòÉΓòÉ
  699.  
  700. The following limitations exist (per project) when creating application help 
  701. resource files: 
  702.  
  703. o 1 Primary Menu 
  704.  
  705.   The first MENU statement found is the one used.  Any following MENU 
  706.   statements are ignored. Generally, applications have a menu used in the menu 
  707.   bar, and some may have a pop-up menu containing a sub-set of the regular 
  708.   menu.  The IPF Editor will generate help resource files that will provide 
  709.   help for both menus automatically. 
  710.  
  711. o 256 Menu Items 
  712.  
  713. o 4096 Panel Definition Names from Include Files 
  714.  
  715.   Include files contain base ID code and definition and are automatically 
  716.   converted to PANEL_xxxx statements as required by your tagged document(s). 
  717.  
  718. o 128 Dialog boxes 
  719.  
  720. o 32 Controls per dialog box 
  721.  
  722. o 32 Include Files (containing definitions for dialog and menu items) 
  723.  
  724.  
  725. ΓòÉΓòÉΓòÉ 5. Compiling Projects and Files ΓòÉΓòÉΓòÉ
  726.  
  727. The IPF Editor provides you with an easy to use interface to your IPF Compiler 
  728. (part of the OS/2 2.x Toolkit).  You can select the type of file to create 
  729. (online help or online document), what level of file errors to look for, 
  730. whether to generate a cross reference list, and what the name should be for the 
  731. file being created. 
  732.  
  733. Of course if you are using the Project capabilities of the IPF Editor most of 
  734. these fields will be filled out for you automatically.  The only choice you 
  735. will have to make is whether or not to display the results in the "Result 
  736. Window." 
  737.  
  738.  
  739. ΓòÉΓòÉΓòÉ 5.1. Output Files ΓòÉΓòÉΓòÉ
  740.  
  741. The IPF Compiler will generate either a .HLP or a .INF file based on the type 
  742. of file being produced.  If you are generating an "online document" for use 
  743. with the OS/2 VIEW.EXE program you will produce a .INF file.  If you are 
  744. creating a help file you will create a .HLP file. 
  745.  
  746. Note:  If you are creating online help files you must have created the help 
  747. resource tables required for building into your application.  See "Generating 
  748. Application Online Help Files" for more details. 
  749.  
  750.  
  751. ΓòÉΓòÉΓòÉ 5.2. IPFC Environment Variable ΓòÉΓòÉΓòÉ
  752.  
  753. The IPF Compiler requires an IPFC environment variable value to operate 
  754. correctly. It points to the IPFC directory in the OS/2 2.x Toolkit.  This is 
  755. filled in automatically by the IPF Editor if you have the IPFC environment 
  756. variable defined in your CONFIG.SYS.  If you don't have it predefined you will 
  757. need to fill this value with the path to the \TOOLKT20\IPFC directory. 
  758.  
  759.  
  760. ΓòÉΓòÉΓòÉ 5.3. IPF Compiler Path ΓòÉΓòÉΓòÉ
  761.  
  762. The IPF Editor needs to know where to locate your IPF Compiler.  If the IPFC 
  763. compiler is in your OS/2 PATH, you will not need to specify the path 
  764. implicitly.  If it isn't, you will need to use enter the location of your IPFC 
  765. compiler. 
  766.  
  767. Note:  You will only need to do this once since the IPF Editor remembers where 
  768. you last specified the location of your IPF Compiler. 
  769.  
  770.  
  771. ΓòÉΓòÉΓòÉ 5.4. IPF Compiler Results Window ΓòÉΓòÉΓòÉ
  772.  
  773. The IPF Compiler Results window shows you the results of your last IPF Compiler 
  774. compile. You may scroll through the list of messages shown in it.  If you see 
  775. an error message (a message that starts with "<filename:n> nnn") you may double 
  776. click on it and you will be taken directly to the error in that file and the 
  777. location in that file. 
  778.  
  779. The following shows how to read an error message: 
  780.  
  781.     <IPFEHHLP.IPF:1> 101: Invalid Document Body.
  782.  
  783. The file and the line number containing the error is shown in the opening 
  784. brackets.  The next number (in the example 101) shows both the severity 
  785. (indicated by the one-hundred level number) and the error message index (the 01 
  786. portion).  If you look up error 101 you will see that it is an "Invalid 
  787. Document Body" message. 
  788.  
  789.  
  790. ΓòÉΓòÉΓòÉ 6. Generating Hypertext Links ΓòÉΓòÉΓòÉ
  791.  
  792. To generate hypertext/graphics links you can either manually mark and select 
  793. panel headers to link text to or use the "Application Generate 
  794. Auto-Hypertext/graphics links" menu option.  This will scan either the current 
  795. file or the current project (or any files in the current project you select) 
  796. for any words that match panel headings defined in any file in the current 
  797. project.  The IPF Editor inserts the appropriate hyperlink command 
  798. automatically.  Matches are based on the heading name matching exactly (not 
  799. counting case) text in the file.  If the text being linked ends with an 'S' (as 
  800. in a plural version of the word) the 'S' will be included in the hypertext 
  801. link. 
  802.  
  803. This function can take from several seconds to several hours depending on the 
  804. size of your project and the speed of your system.  However, all activity takes 
  805. place in the background so you can use your system for other operations while 
  806. the auto hyperlinking is taking place. 
  807.  
  808.  
  809. ΓòÉΓòÉΓòÉ 7. Sorting Panel Headers ΓòÉΓòÉΓòÉ
  810.  
  811. In order to sort panel headers in your project you will need to be sure that 
  812. each individual IPF file is sorted in the manner you want (i.e. the first panel 
  813. header in the file is the file you want to precede all other panel headers in 
  814. that file). 
  815.  
  816. If you wish to rearrange the panel headers in several different files you will 
  817. need to edit the base IPF file created by the IPF Editor.  This file contains 
  818. several "┬╖imbed" statements, one per IPF file in your project.  By changing the 
  819. order of these statements you can alter the order of the IPF file's panel's in 
  820. the document's table of contents. 
  821.  
  822.  
  823. ΓòÉΓòÉΓòÉ 8. IPF Commands Supported ΓòÉΓòÉΓòÉ
  824.  
  825. The "IPF Commands" menu lets you select different tags to add to your 
  826. documentation. You can access most of these menu options from the pop-up menu 
  827. by pressing the right mouse button while the pointer is over the document 
  828. editing window or the most common commands from the "graphical menu" located at 
  829. the right side of the IPF Editor window. 
  830.  
  831. The IPF Editor provides a majority of the IPF tag commands you will require in 
  832. everyday use.  You may, of course, use any other standard IPF tag described in 
  833. the IPF documentation even if it isn't supported directly by the IPF Editor. 
  834. Just type the commands in directly. 
  835.  
  836.  
  837. ΓòÉΓòÉΓòÉ 8.1. Special IPF Commands Menu ΓòÉΓòÉΓòÉ
  838.  
  839. This menu lets you access tags that are less commonly used.  You can mark the 
  840. document title, body of the document, hypertext/graphics links, etc.  Most of 
  841. the commands you would commonly use in this menu can be accessed via the pop-up 
  842. menu or the graphical menu but are here to support whichever method you find 
  843. the most convenient. 
  844.  
  845.  
  846. ΓòÉΓòÉΓòÉ 8.2. Title Tag Information ΓòÉΓòÉΓòÉ
  847.  
  848. This tag lets you specify the title of the document you are editing. This tag 
  849. is only valid for online documents and shouldn't be used for online help 
  850. windows.  The maximum length the title can be is 47 characters, including 
  851. spaces and blanks. 
  852.  
  853. Tagging Information 
  854.  
  855.  Insert this tag on a blank line following the :userdoc. tag.  The following 
  856. shows the proper usage of the :title. tag: 
  857.  
  858.     :userdoc.
  859.     :title.Using the Title Tag
  860.     :h1 res=100.A Panel Heading
  861.     :p.This is an example.
  862.     :euserdoc.
  863.  
  864. If you were to compile this example it would generate an online document and 
  865. place "Using the Title Tag" in the title line of the main window. 
  866.  
  867. Note:  If you are using the project option, and creating an automatic base 
  868.        file, you never need to use this tag as it is automatically placed in 
  869.        the base IPF file when you create the project. 
  870.  
  871.  
  872. ΓòÉΓòÉΓòÉ 8.3. User Documentation Tags Information ΓòÉΓòÉΓòÉ
  873.  
  874. These tags (:userdoc. and :euserdoc.) are placed at the beginning and ending of 
  875. your document.  These allow the IPFC compiler to correctly determine the 
  876. complete contents of your document.  The following shows a very brief sample 
  877. document that uses the user document tags: 
  878.  
  879.     :userdoc.
  880.     :body.
  881.  
  882.     ┬╖* This is a comment in an empty documentation file.
  883.  
  884.     :euserdoc.
  885.  
  886. Tagging Information 
  887.  
  888.  Place the :userdoc. before any other statements in your document file and the 
  889. :euserdoc. after all the statements in your document file.  Both statements 
  890. must reside in the same file and you must not use these statements more than 
  891. once in the same document. 
  892.  
  893. Note:  If you are using the project option, and creating an automatic base 
  894.        file, you never need to use this tag as it is automatically placed in 
  895.        the base IPF file. 
  896.  
  897.  
  898. ΓòÉΓòÉΓòÉ 8.4. Body Tag Information ΓòÉΓòÉΓòÉ
  899.  
  900. This (:body.) marks the beginning of the text body for your IPF documentation 
  901. file.  This must be placed after the :userdoc.  tag and normally also after the 
  902. :title. tag. This must be placed before any heading tags or commands to imbed 
  903. other IPF files into your document. 
  904.  
  905. Tagging Information 
  906.  
  907.  Place this after the :userdoc. and :title. statements but before any heading 
  908. or imbed statements. 
  909.  
  910.     :userdoc.
  911.     :body.
  912.  
  913.  
  914.     :euserdoc.
  915.  
  916. Note:  If you are using the project option, and creating an automatic base 
  917.        file, you never need to use this tag as it is automatically placed in 
  918.        the base IPF file. 
  919.  
  920.  
  921. ΓòÉΓòÉΓòÉ 8.5. Comment Tag Information ΓòÉΓòÉΓòÉ
  922.  
  923. This tag (┬╖*) marks the rest of the current line to the right of it as a 
  924. comment.  It is ignored by the IPFC compiler.  You can use this tag to help 
  925. keep track of revisions to the documentation and to add comments describing 
  926. links to other documents, etc. 
  927.  
  928. Tagging Information 
  929.  
  930.  Place the cursor anywhere in your document and then select the comment tag 
  931. menu item.  The tag will be inserted at that location and everything to the 
  932. right of the tag will be considered a comment and not show up in your output 
  933. document. 
  934.  
  935.     ┬╖* This is a comment.
  936.     ┬╖* This is a second comment.
  937.  
  938.  
  939. ΓòÉΓòÉΓòÉ 8.6. Imbed File Tag Information ΓòÉΓòÉΓòÉ
  940.  
  941. The imbed file tag (┬╖im  filename) lets you imbed (include or merge when the 
  942. document is compiled) a specific IPF document file into the current document. 
  943. Usually this command is used in a base file to include different chapters (each 
  944. located in a different file) into a single online document. 
  945.  
  946. This online help was split up into separate files, one for each submenu and one 
  947. for each dialog box to make maintenance easier. 
  948.  
  949. Tagging Information 
  950.  
  951.  To use this option place the cursor on a blank line in your document, select 
  952. this option, then select the IPF document file to imbed. 
  953.  
  954.     :userdoc.
  955.     :body.
  956.     ┬╖im chapter1.ipf
  957.     ┬╖im chapter2.ipf
  958.     ┬╖im chapter3.ipf
  959.     :euserdoc.
  960.  
  961. Note:  If you are using the project option, and creating an automatic base 
  962.        file, you never need to use this tag as it is automatically placed in 
  963.        the base IPF file. 
  964.  
  965.  If you wish to add a new file to the project use the "File New" command to 
  966. create a new file, then paste the new text into it. 
  967.  
  968.  
  969. ΓòÉΓòÉΓòÉ 8.7. Setup Button Controls ΓòÉΓòÉΓòÉ
  970.  
  971. This option lets you define what buttons are displayed below your help 
  972. page/online document in either the Help Window or View program.  You can select 
  973. to show the Previous, Search, Next, Index, etc. buttons in your document. 
  974.  
  975. The default buttons shown (if you don't specify this command) are: 
  976.  
  977. o Online Documents 
  978.  
  979.    - Previous 
  980.  
  981.    - Search 
  982.  
  983.    - Print 
  984.  
  985.    - Index 
  986.  
  987.    - Contents 
  988.  
  989.    - Back 
  990.  
  991.    - Forward 
  992.  
  993.    - Tutorial (but only if a tutorial is available). 
  994.  
  995. o Help windows 
  996.  
  997.    - Previous 
  998.  
  999.    - Search 
  1000.  
  1001.    - Print 
  1002.  
  1003.    - Index 
  1004.  
  1005.    - Tutorial (but only if a tutorial is available). 
  1006.  
  1007.  
  1008. ΓòÉΓòÉΓòÉ 8.7.1. Push-Button Control Selection ΓòÉΓòÉΓòÉ
  1009.  
  1010. This dialog allows you to select which push-buttons you want activated in your 
  1011. help document. 
  1012.  
  1013.  
  1014. ΓòÉΓòÉΓòÉ 8.7.2. Search ΓòÉΓòÉΓòÉ
  1015.  
  1016. Selecting this will cause the "Search" push button to be displayed at the 
  1017. bottom of the document window. 
  1018.  
  1019.  
  1020. ΓòÉΓòÉΓòÉ 8.7.3. Print ΓòÉΓòÉΓòÉ
  1021.  
  1022. Selecting this will cause the "Print" push button to be displayed at the bottom 
  1023. of the document window. 
  1024.  
  1025.  
  1026. ΓòÉΓòÉΓòÉ 8.7.4. Index ΓòÉΓòÉΓòÉ
  1027.  
  1028. Selecting this will cause the "Index" push button to be displayed at the bottom 
  1029. of the document window. 
  1030.  
  1031.  
  1032. ΓòÉΓòÉΓòÉ 8.7.5. Contents ΓòÉΓòÉΓòÉ
  1033.  
  1034. Selecting this will cause the "Contents" push button to be displayed at the 
  1035. bottom of the document window. 
  1036.  
  1037.  
  1038. ΓòÉΓòÉΓòÉ 8.7.6. Esc ΓòÉΓòÉΓòÉ
  1039.  
  1040. Selecting this will cause the "Esc" push button to be displayed at the bottom 
  1041. of the document window. 
  1042.  
  1043.  
  1044. ΓòÉΓòÉΓòÉ 8.7.7. Back ΓòÉΓòÉΓòÉ
  1045.  
  1046. Selecting this will cause the "Back" push button to be displayed at the bottom 
  1047. of the document window. 
  1048.  
  1049.  
  1050. ΓòÉΓòÉΓòÉ 8.7.8. Forward ΓòÉΓòÉΓòÉ
  1051.  
  1052. Selecting this will cause the "Forward" push button to be displayed at the 
  1053. bottom of the document window. 
  1054.  
  1055.  
  1056. ΓòÉΓòÉΓòÉ 8.7.9. Page ΓòÉΓòÉΓòÉ
  1057.  
  1058. This will assign the control settings to either the current panel heading only. 
  1059.  
  1060.  
  1061. ΓòÉΓòÉΓòÉ 8.7.10. Coverpage ΓòÉΓòÉΓòÉ
  1062.  
  1063. This will assign the control settings to the main window (unless over-ridden by 
  1064. another control button setup for a specific page (panel heading). 
  1065.  
  1066.  
  1067. ΓòÉΓòÉΓòÉ 8.7.11. Res Code Identifier ΓòÉΓòÉΓòÉ
  1068.  
  1069. Selecting this will let you define a res. code for push button control 
  1070.  
  1071.  
  1072. ΓòÉΓòÉΓòÉ 8.7.12. Name Identifier ΓòÉΓòÉΓòÉ
  1073.  
  1074. Selecting htis will let you define a name indentifier for the push button 
  1075. control 
  1076.  
  1077.  
  1078. ΓòÉΓòÉΓòÉ 8.8. Paragraph Tag Information ΓòÉΓòÉΓòÉ
  1079.  
  1080. The paragraph tag (:p.) is one of the most common tags to use.  It marks the 
  1081. start of a paragraph and the paragraph continues until another tag, marking 
  1082. either a new paragraph or some other sectional tag (such as lists or 
  1083. sub-sections), is placed. 
  1084.  
  1085. Tagging Information 
  1086.  
  1087.  The paragraph tag can most easily be placed by positioning the cursor at the 
  1088. beginning of a paragraph, pressing the right button, and selecting the 
  1089. currently highlighted paragraph menu option.  (To speed tagging, you may wish 
  1090. to just place the cursor anywhere on the first word in the paragraph, double 
  1091. click with the left button, then press the right button to insert the tag). 
  1092.  
  1093. The following shows the typical use of the paragraph tag: 
  1094.  
  1095.     :h1 res=100.File Open Help
  1096.     :p.This menu option allows you to open files.
  1097.  
  1098. Note:  You may also generate the paragraph tag by pressing ALT-P. 
  1099.  
  1100.  
  1101. ΓòÉΓòÉΓòÉ 8.9. Panel Header Tag Information ΓòÉΓòÉΓòÉ
  1102.  
  1103. The panel header tags provide you with the ability to create separate panels 
  1104. for different parts of your documentation.  Generally, each heading in your 
  1105. online documentation has a panel header tag.  Panel header tags are also used 
  1106. to allow hyper-text and hyper-graphic links to be made to different portions of 
  1107. the document.  The IPF Editor currently supports up to 32,000 panel header tags 
  1108. in a single project. 
  1109.  
  1110. There are six levels of panel headers available.  Generally each panel header 
  1111. level represents a different level in the table of contents.  Level one headers 
  1112. always are displayed in the table of contents, while header two are not shown 
  1113. unless the level headers are expanded. In this online help document, the 
  1114. sub-menus are all level one headers, while the menu items themselves are level 
  1115. two menu items.  Some reference panels are level three or deeper headers.  It 
  1116. is important to remember that only panel header levels 1 through 3 may be 
  1117. linked to using hypertext/graphics links. 
  1118.  
  1119. You may have chosen to require either panel header res codes, panel header tag 
  1120. names, or header tag ID's.  If you choose panel header tag names, and have 
  1121. loaded a C Language Include file, you will see a list of possible definitions 
  1122. to use for your res codes and name codes.  This option is only available in the 
  1123. professional (registered) version of the IPF Editor.  You may also use the 
  1124. auto-increment feature and enter your own res codes to build a document without 
  1125. an external definition list.   If you are using the pre-defined definitions the 
  1126. auto-increment feature is not used on the selected res number. 
  1127.  
  1128. Panel header name codes are usually generated from the C Language Include file 
  1129. when generating online help  files. Otherwise you may type in your own name for 
  1130. the panel being generated.  Generally, the panel name should be 32 characters 
  1131. or less, and have some relevance to the panel being marked. 
  1132.  
  1133. Tagging Information 
  1134.  
  1135.  To create a panel header mark the text you want to use for the panel header 
  1136. title using your mouse to select the desired text.  Then select the 
  1137. header-level you desire from the menu.  Then choose the pre-defined definition 
  1138. or enter in the res number, panel name, and tag ID as required. 
  1139.  
  1140. Some headers may not require res, name, or tag values if they are merely part 
  1141. of a document and won't be hyper-linked to.  Panels that will not be 
  1142. hyperlinked to do not requires res codes. 
  1143.  
  1144. The following shows a typical panel header definition: 
  1145.  
  1146.     :h1 res=100.Panel Name
  1147.     :p.This is a panel with a panel header at level 1.
  1148.  
  1149.  
  1150. ΓòÉΓòÉΓòÉ 8.9.1. Panel Header 1 Information ΓòÉΓòÉΓòÉ
  1151.  
  1152. This generates a first level panel header that will show up in the documents 
  1153. table of contents. 
  1154.  
  1155. Note:  This panel header is a linkable panel header (this means that 
  1156.        hypertext/graphics links may be made to this panel header). 
  1157.  
  1158.  
  1159. ΓòÉΓòÉΓòÉ 8.9.2. Panel Header 2 Information ΓòÉΓòÉΓòÉ
  1160.  
  1161. This generates a second level panel header that will show up in the documents 
  1162. table of contents. 
  1163.  
  1164. Note:  This panel header is a linkable panel header (this means that 
  1165.        hypertext/graphics links may be made to this panel header). 
  1166.  
  1167.  
  1168. ΓòÉΓòÉΓòÉ 8.9.3. Panel Header 3 Information ΓòÉΓòÉΓòÉ
  1169.  
  1170. This generates a third level header that will show up in the documents table of 
  1171. contents. 
  1172.  
  1173. Note:  This panel header is a linkable panel header (this means that 
  1174.        hypertext/graphics links may be made to this panel header). 
  1175.  
  1176.  
  1177. ΓòÉΓòÉΓòÉ 8.9.4. Panel Header 4 Information ΓòÉΓòÉΓòÉ
  1178.  
  1179. This generates a fourth level panel header that will show up in the documents 
  1180. table of contents. 
  1181.  
  1182. Note:  This level panel header may not be linked via hypertext/graphics links. 
  1183.  
  1184.  
  1185. ΓòÉΓòÉΓòÉ 8.9.5. Panel Header 5 Information ΓòÉΓòÉΓòÉ
  1186.  
  1187. This generates a fifth level panel header that will show up in the documents 
  1188. table of contents. 
  1189.  
  1190. Note:  This level panel header may not be linked via hypertext/graphics links. 
  1191.  
  1192.  
  1193. ΓòÉΓòÉΓòÉ 8.9.6. Panel Header 6 Information ΓòÉΓòÉΓòÉ
  1194.  
  1195. This generates a sixth level panel header that will show up in the documents 
  1196. table of contents. 
  1197.  
  1198. Note:  This level panel header may not be linked via hypertext/graphics links. 
  1199.  
  1200.  
  1201. ΓòÉΓòÉΓòÉ 8.10. Highlighting Tag Information ΓòÉΓòÉΓòÉ
  1202.  
  1203. Use these options to select different appearances for selected text.  You can 
  1204. choose any of the following text formats: 
  1205.  
  1206. o This is an example of :hp1. 
  1207. o This is an example of :hp2. 
  1208. o This is an example of :hp3. 
  1209. o This is an example of :hp4. 
  1210. o This is an example of :hp5. 
  1211. o This is an example of :hp6. 
  1212. o This is an example of :hp7. 
  1213. o This is an example of :hp8. 
  1214. o This is an example of :hp9. 
  1215.  
  1216. Tagging Information 
  1217.  
  1218.  Place the cursor at the beginning of the text to be marked and select it. 
  1219. Then choose the desired highlighting method.  A :hp1. and :eh1. (or whatever 
  1220. method you chose from 1 to 9) will be inserted into the text. 
  1221.  
  1222.  
  1223. ΓòÉΓòÉΓòÉ 8.10.1. Highlighting Italics Information ΓòÉΓòÉΓòÉ
  1224.  
  1225. This is an example of :hp1. Italics text. 
  1226.  
  1227. See Highlighting Tag Information for usage details. 
  1228.  
  1229.  
  1230. ΓòÉΓòÉΓòÉ 8.10.2. Highlighting Bold Information ΓòÉΓòÉΓòÉ
  1231.  
  1232. This is an example of :hp2. bold text. 
  1233.  
  1234. See Highlighting Tag Information for usage details. 
  1235.  
  1236.  
  1237. ΓòÉΓòÉΓòÉ 8.10.3. Highlighting Bold Italics Information ΓòÉΓòÉΓòÉ
  1238.  
  1239. This is an example of :hp3. bold italics. 
  1240.  
  1241. See Highlighting Tag Information for usage details. 
  1242.  
  1243.  
  1244. ΓòÉΓòÉΓòÉ 8.10.4. Highlighting Blue Information ΓòÉΓòÉΓòÉ
  1245.  
  1246. This is an example of :hp4. blue text. 
  1247.  
  1248. See Highlighting Tag Information for usage details. 
  1249.  
  1250.  
  1251. ΓòÉΓòÉΓòÉ 8.10.5. Highlighting Underlined Information ΓòÉΓòÉΓòÉ
  1252.  
  1253. This is an example of :hp5. underlined text. 
  1254.  
  1255. See Highlighting Tag Information for usage details. 
  1256.  
  1257.  
  1258. ΓòÉΓòÉΓòÉ 8.10.6. Highlighting Underlined Italics Information ΓòÉΓòÉΓòÉ
  1259.  
  1260. This is an example of :hp6. underlined italics text. 
  1261.  
  1262. See Highlighting Tag Information for usage details. 
  1263.  
  1264.  
  1265. ΓòÉΓòÉΓòÉ 8.10.7. Highlighting Underlined Blue Information ΓòÉΓòÉΓòÉ
  1266.  
  1267. This is an example of :hp7. underlined blue text. 
  1268.  
  1269. See Highlighting Tag Information for usage details. 
  1270.  
  1271.  
  1272. ΓòÉΓòÉΓòÉ 8.10.8. Highlighting Red Information ΓòÉΓòÉΓòÉ
  1273.  
  1274. This is an example of :hp8. red text. 
  1275.  
  1276. See Highlighting Tag Information for usage details. 
  1277.  
  1278.  
  1279. ΓòÉΓòÉΓòÉ 8.10.9. Highlighting Magenta Information ΓòÉΓòÉΓòÉ
  1280.  
  1281. This is an example of :hp9. magenta text. 
  1282.  
  1283. See Highlighting Tag Information for usage details. 
  1284.  
  1285.  
  1286. ΓòÉΓòÉΓòÉ 8.11. Figures/Artwork Tag Information ΓòÉΓòÉΓòÉ
  1287.  
  1288. This menu provides you with the ability to add both figures (and captions), 
  1289. bitmap graphics, and character graphics to your document. 
  1290.  
  1291.  
  1292. ΓòÉΓòÉΓòÉ 8.11.1. Figure Tag Information ΓòÉΓòÉΓòÉ
  1293.  
  1294. The figure tags allow you to mark text as a figure that will be displayed in a 
  1295. format exactly as entered.  The tags that surround figures are :fig. and :efig. 
  1296.  
  1297. Tagging Information 
  1298.  
  1299.  Mark the selected text to be identified as a figure using your mouse then 
  1300. select the Figure Tag menu item. 
  1301.  
  1302. The following shows the markings for a text figure: 
  1303.  
  1304. :fig.
  1305.          A            B               C         D        E
  1306.      1  $100.00       $ -45.00        This spreadsheet shows
  1307.      2  $200.00       $ 131.15        text captured from my spreadsheet
  1308.      3  $150.00       $  22.20        program.
  1309.      4  @SUM(A1..A3)  @SUM(B1..B3)
  1310.      5
  1311. :efig.
  1312.  
  1313. This will look like the following in your document: 
  1314.  
  1315.  
  1316.      A       B        C     D     E
  1317.    1  $100.00    $ -45.00     This spreadsheet shows
  1318.    2  $200.00    $ 131.15     text captured from my spreadsheet
  1319.    3  $150.00    $  22.20     program.
  1320.    4  @SUM(A1..A3)  @SUM(B1..B3)
  1321.    5
  1322.  
  1323.  
  1324. ΓòÉΓòÉΓòÉ 8.11.2. Figure Caption Tag Information ΓòÉΓòÉΓòÉ
  1325.  
  1326. This (:figcap.) allows you to add a title to figures. 
  1327.  
  1328. Tagging Information 
  1329.  
  1330.  The pointer is placed between the :fig. and :efig. statements and then select 
  1331. this option. 
  1332.  
  1333.  
  1334. ΓòÉΓòÉΓòÉ 8.11.3. Character Graphics Tag Information ΓòÉΓòÉΓòÉ
  1335.  
  1336. These tags (:cgraphic. and :ecgraphic.) identify marked text as a character 
  1337. graphic that will be displayed in the monospace system font.  A blank line is 
  1338. inserted before and after the graphic. 
  1339.  
  1340. Tagging Information 
  1341.  
  1342.  Mark the graphic text and then select the the Character Graphics menu item. 
  1343.  
  1344. Note:  This can be used to display the character graphics symbols that consist 
  1345. of the upper 128 bytes in the ASCII table. 
  1346.  
  1347.  
  1348. ΓòÉΓòÉΓòÉ 8.11.4. Artwork Tag Information ΓòÉΓòÉΓòÉ
  1349.  
  1350. This tag (:artwork filename.) allows you to include bitmaps and metafiles into 
  1351. your document. 
  1352.  
  1353. Tagging Information 
  1354.  
  1355.  Place the pointer where you wish to insert the bitmap and then select the 
  1356. Artwork menu item or select the  graphics menu item.  Select the bitmap to 
  1357. insert from the file list, then determine alignment for the bitmap (either 
  1358. left, center, right, in-line, or no alignment). 
  1359.  
  1360. The following shows a typical bitmap displayed: 
  1361.  
  1362. The above bitmap was loaded using the following tag: 
  1363.  
  1364.     :artwork name='IPFEDIT.BMP' align=left.
  1365.  
  1366. You may wish to edit the path to the bitmap so that it doesn't include the 
  1367. drive label if you plan on working on the document on several different 
  1368. computers (unless each computer has the same drive/directory structure). 
  1369.  
  1370.  
  1371. ΓòÉΓòÉΓòÉ 8.11.4.1. Artwork Setup ΓòÉΓòÉΓòÉ
  1372.  
  1373. The Artwork setup page allows you to select artwork (either bitmaps or 
  1374. metafiles) for inclusion in your online document. 
  1375.  
  1376.  
  1377. ΓòÉΓòÉΓòÉ 8.11.4.2. Bitmap/Metafile Name ΓòÉΓòÉΓòÉ
  1378.  
  1379. This field contains the name of the bitmap or metafile to include in your 
  1380. document.  Normally this field is filled in when you press the Select Graphic 
  1381. button but you may manually enter any bitmap or metafile name here, instead. 
  1382.  
  1383.  
  1384. ΓòÉΓòÉΓòÉ 8.11.4.3. Select Graphic ΓòÉΓòÉΓòÉ
  1385.  
  1386. This will bring up a file dialog that will allow you to select a bitmap or 
  1387. metafile for inclusion into your document. 
  1388.  
  1389.  
  1390. ΓòÉΓòÉΓòÉ 8.11.4.4. Preview ΓòÉΓòÉΓòÉ
  1391.  
  1392. This will display the selected bitmap in a window so that you may verify you 
  1393. have chosen the correct art. 
  1394.  
  1395.  
  1396. ΓòÉΓòÉΓòÉ 8.11.4.5. Link Artwork ΓòÉΓòÉΓòÉ
  1397.  
  1398. This option is not currently supported, sorry.  Future versions will support 
  1399. this option.  Please use the hypertext/graphics link to link artwork. 
  1400.  
  1401.  
  1402. ΓòÉΓòÉΓòÉ 8.11.4.6. Alignment Left ΓòÉΓòÉΓòÉ
  1403.  
  1404. This will align the artwork at the left portion of the display. 
  1405.  
  1406.  
  1407. ΓòÉΓòÉΓòÉ 8.11.4.7. Alignment Center ΓòÉΓòÉΓòÉ
  1408.  
  1409. This will align the artwork in the center part of the display. 
  1410.  
  1411.  
  1412. ΓòÉΓòÉΓòÉ 8.11.4.8. Alignment Right ΓòÉΓòÉΓòÉ
  1413.  
  1414. This will align the artwork at the right portion of the display. 
  1415.  
  1416.  
  1417. ΓòÉΓòÉΓòÉ 8.11.4.9. Alignment In-Line ΓòÉΓòÉΓòÉ
  1418.  
  1419. This will place the artwork in the middle of the line, as shown below: 
  1420.  
  1421. The symbol, , is in the middle of this line. 
  1422.  
  1423.  
  1424. ΓòÉΓòÉΓòÉ 8.11.4.10. Alignment Fit ΓòÉΓòÉΓòÉ
  1425.  
  1426. This will fit the artwork into the current display page (compressing or 
  1427. exanding it as necessary). 
  1428.  
  1429.  
  1430. ΓòÉΓòÉΓòÉ 8.11.4.11. Alignment None ΓòÉΓòÉΓòÉ
  1431.  
  1432. This will place the artwork at the current location and not adjust its size or 
  1433. position at all. 
  1434.  
  1435.  
  1436. ΓòÉΓòÉΓòÉ 8.11.4.12. Artwork Setup Save ΓòÉΓòÉΓòÉ
  1437.  
  1438. This will save your select artwork and insert it into your document. 
  1439.  
  1440.  
  1441. ΓòÉΓòÉΓòÉ 8.12. Foreground Color Tag ΓòÉΓòÉΓòÉ
  1442.  
  1443. These tags (:fc=color.) lets you change the documents output color.  The color 
  1444. remains set to this until the next panel header is encountered or until a new 
  1445. :fc=color. command is encountered. 
  1446.  
  1447. Tagging Information 
  1448.  
  1449.  Place the pointer at the location where you wish to start changing the color 
  1450. and then select the foreground color command from the color list. 
  1451.  
  1452.  
  1453. ΓòÉΓòÉΓòÉ 8.12.1. fc=default ΓòÉΓòÉΓòÉ
  1454.  
  1455. This sets the current foreground text color to the default (Whatever the user 
  1456. has selected for the default help information text color).  The color stays in 
  1457. effect until a new color is selected or until the panel description ends. 
  1458.  
  1459.  
  1460. ΓòÉΓòÉΓòÉ 8.12.2. fc=blue Information ΓòÉΓòÉΓòÉ
  1461.  
  1462. This sets the current foreground text color to blue.  The color stays in effect 
  1463. until a new color is selected or until the panel description ends. 
  1464.  
  1465.  
  1466. ΓòÉΓòÉΓòÉ 8.12.3. fc=cyan Information ΓòÉΓòÉΓòÉ
  1467.  
  1468. This sets the current foreground text color to cyan.  The color stays in effect 
  1469. until a new color is selected or until the panel description ends. 
  1470.  
  1471.  
  1472. ΓòÉΓòÉΓòÉ 8.12.4. fc=green Information ΓòÉΓòÉΓòÉ
  1473.  
  1474. This sets the current foreground text color to green.  The color stays in 
  1475. effect until a new color is selected or until the panel description ends. 
  1476.  
  1477.  
  1478. ΓòÉΓòÉΓòÉ 8.12.5. fc=neutral Information ΓòÉΓòÉΓòÉ
  1479.  
  1480. This sets the current foreground text color to neutral (this is the same as the 
  1481. help manager background color).  The color stays in effect until a new color is 
  1482. selected or until the panel description ends. 
  1483.  
  1484.  
  1485. ΓòÉΓòÉΓòÉ 8.12.6. fc=yellow Information ΓòÉΓòÉΓòÉ
  1486.  
  1487. This sets the current foreground text color to yellow.  The color stays in 
  1488. effect until a new color is selected or until the panel description ends. 
  1489.  
  1490.  
  1491. ΓòÉΓòÉΓòÉ 8.13. Background Color Tag Information ΓòÉΓòÉΓòÉ
  1492.  
  1493. These tags (:bc=color.) lets you change the documents output background color. 
  1494. The color remains set to this until the next panel is encountered or until a 
  1495. new :bc=color. command is encountered. 
  1496.  
  1497. Tagging Information 
  1498.  
  1499.  Place the pointer at the location where you wish to start changing the text 
  1500. background color and then select the background color command from the color 
  1501. list. 
  1502.  
  1503.  
  1504. ΓòÉΓòÉΓòÉ 8.13.1. bc=default Information ΓòÉΓòÉΓòÉ
  1505.  
  1506. This sets the current background text color to the default (Whatever the user 
  1507. has selected for the default help information text color).  The color stays in 
  1508. effect until a new color is selected or until the panel description ends. 
  1509.  
  1510.  
  1511. ΓòÉΓòÉΓòÉ 8.13.2. bc=blue Information ΓòÉΓòÉΓòÉ
  1512.  
  1513. This sets the current background text color to blue.  The color stays in effect 
  1514. until a new color is selected or until the panel description ends. 
  1515.  
  1516.  
  1517. ΓòÉΓòÉΓòÉ 8.13.3. bc=cyan Information ΓòÉΓòÉΓòÉ
  1518.  
  1519. This sets the current background text color to cyan.  The color stays in effect 
  1520. until a new color is selected or until the panel description ends. 
  1521.  
  1522.  
  1523. ΓòÉΓòÉΓòÉ 8.13.4. bc=green Information ΓòÉΓòÉΓòÉ
  1524.  
  1525. This sets the current background text color to green.  The color stays in 
  1526. effect until a new color is selected or until the panel description ends. 
  1527.  
  1528.  
  1529. ΓòÉΓòÉΓòÉ 8.13.5. bc=neutral Information ΓòÉΓòÉΓòÉ
  1530.  
  1531. This sets the current background text color to neutral (this is the same as the 
  1532. help manager background color).  The color stays in effect until a new color is 
  1533. selected or until the panel description ends. 
  1534.  
  1535.  
  1536. ΓòÉΓòÉΓòÉ 8.13.6. bc=yellow Information ΓòÉΓòÉΓòÉ
  1537.  
  1538. This sets the current foreground text color to yellow.  The color stays in 
  1539. effect until a new color is selected or until the panel description ends. 
  1540.  
  1541.  
  1542. ΓòÉΓòÉΓòÉ 8.14. Sub-Sections Menu Information ΓòÉΓòÉΓòÉ
  1543.  
  1544. These IPF commands allow you to mark text as notes, note paragraphs, examples, 
  1545. footnotes, warnings, and tables. 
  1546.  
  1547.  
  1548. ΓòÉΓòÉΓòÉ 8.14.1. Caution Information ΓòÉΓòÉΓòÉ
  1549.  
  1550. The Caution tag allows you to mark a section of text using the caution 
  1551. attribute. 
  1552.  
  1553. Tagging Information 
  1554.  
  1555.  Place the pointer before the text to display as a cautionary statement, then 
  1556. select the caution tag. 
  1557.  
  1558. The following shows an example of the Caution tag:  :caution.This is an example 
  1559. of the caution tag.:ecaution. 
  1560.  
  1561. which appears as the following in your document: 
  1562.  
  1563. CAUTION:
  1564. This is an example of the caution tag.
  1565.  
  1566. Note:  You  can insert a blank line after the "CAUTION:" text by starting to 
  1567.        tag on a blank line above the text you wish to include in your caution tag.
  1568.  
  1569.  
  1570. ΓòÉΓòÉΓòÉ 8.14.2. Note Information ΓòÉΓòÉΓòÉ
  1571.  
  1572. The Note tag allows you to add a Note: line into your document. 
  1573.  
  1574. Tagging Information 
  1575.  
  1576.  Place the pointer at the beginning of the line to tag as a single line note. 
  1577. Then select the note tag. 
  1578.  
  1579. The following shows an example of the Note tag: :note.This is a note example. 
  1580.  
  1581. which displays as shown below: 
  1582.  
  1583. Note:  This is a note example. 
  1584.  
  1585.  
  1586. ΓòÉΓòÉΓòÉ 8.14.3. Note Paragraph Information ΓòÉΓòÉΓòÉ
  1587.  
  1588. The Note Paragraph tag lets you create a paragraph note to your document.  This 
  1589. is different from the line note tag which only marks a single line as a note. 
  1590.  
  1591. Below is an example of a paragraph note tag that contains several lines of 
  1592. text: 
  1593.  
  1594.     :nt.The text will wrap around and allow you to place multiple lines of text as needed to complete your note.
  1595.     :ent.
  1596.  
  1597. which displays as shown below: 
  1598.  
  1599. Note:  The text will wrap around and allow you to place multiple lines of text 
  1600.        as needed to complete your note. 
  1601.  
  1602. Note:  If you only need a single line note try the Note tag. 
  1603.  
  1604.  
  1605. ΓòÉΓòÉΓòÉ 8.14.4. Footnote Information ΓòÉΓòÉΓòÉ
  1606.  
  1607. Use this tag to add footnotes to your document.  Footnotes cause a pop-up 
  1608. window to appear with the text you place in the footnote when the user selects 
  1609. a hyperlink to it.  The tag requires that you enter a tag name so that you may 
  1610. use a hyperlink to the footnote. 
  1611.  
  1612. Tagging Information 
  1613.  
  1614.  Mark the desired text for the footnote, then select the footnote command or 
  1615. use the  menu item. 
  1616.  
  1617. The following is a sample footnote: 
  1618.  
  1619.     :fn id=Footnote_sample.
  1620.     This is a footnote.
  1621.     :efn.
  1622.  
  1623. Select Footnote Sample to display the example footnote. 
  1624.  
  1625.  
  1626. ΓòÉΓòÉΓòÉ 8.14.5. Warning Information ΓòÉΓòÉΓòÉ
  1627.  
  1628. This will add the Warning statement to your text. 
  1629.  
  1630. Tagging Information 
  1631.  
  1632.  Mark the desired text then select the warning tag. 
  1633.  
  1634. The following shows a sample tagging: 
  1635.  
  1636. :warning.This is a warning example.:ewarning. 
  1637.  
  1638. which looks like the following: 
  1639.  
  1640. Warning: This is a warning example.
  1641.  
  1642.  
  1643. ΓòÉΓòÉΓòÉ 8.14.6. Example Information ΓòÉΓòÉΓòÉ
  1644.  
  1645. This allows you to mark text as an example. 
  1646.  
  1647. The following shows an example of example tagging: 
  1648.  
  1649.     :xmp.
  1650.     This is an example, showing monospaced text and indentation.
  1651.          Indented just like I typed it.
  1652.     :exmp.
  1653.  
  1654. which displays as follows: 
  1655.  
  1656.     This is an example, showing monospaced text and indentation.
  1657.          Indented just like I typed it.
  1658.  
  1659. Note:  The text is changed to monospaced for examples automatically. 
  1660.  
  1661.  
  1662. ΓòÉΓòÉΓòÉ 8.14.7. Table Information ΓòÉΓòÉΓòÉ
  1663.  
  1664. This lets you create tables, organized by rows and columns.  When you are asked 
  1665. to specify the column size you must enter one width for each column separated 
  1666. by spaces. 
  1667.  
  1668. The table below was created using the following tags: 
  1669.  
  1670.     :table cols='20 15'.
  1671.     :row.
  1672.     :c┬╖Column # 1, Row #1
  1673.     :c┬╖Column # 2, Row #1
  1674.     :row.
  1675.     :c┬╖Column #1, Row # 2
  1676.     :c┬╖Column #2, Row # 2
  1677.     :etable.
  1678.  
  1679. The following shows what the above tagging generates: 
  1680.  
  1681. ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
  1682. ΓöéColumn # 1, Row #1  ΓöéColumn # 2, RowΓöé
  1683. Γöé                    Γöé#1             Γöé
  1684. Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  1685. ΓöéColumn #1, Row # 2  ΓöéColumn #2, Row Γöé
  1686. Γöé                    Γöé# 2            Γöé
  1687. ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
  1688.  
  1689. The entire contents of the table was selected then marked using the Sub-Section 
  1690. Table command with the column sizes entered as "20 15" (signifying that the 
  1691. first column is 20 characters wide and the second 15).  Then each column and 
  1692. row were marked individually using the Table Row and Table Column commands. 
  1693.  
  1694.  
  1695. ΓòÉΓòÉΓòÉ 8.14.7.1. Table Row Information ΓòÉΓòÉΓòÉ
  1696.  
  1697. This lets you mark text as the start of a new row in a table. 
  1698.  
  1699.  
  1700. ΓòÉΓòÉΓòÉ 8.14.7.2. Table Column Information ΓòÉΓòÉΓòÉ
  1701.  
  1702. This lets you mark text as the start of a new column in a table. 
  1703.  
  1704.  
  1705. ΓòÉΓòÉΓòÉ 8.15. List Menu Information ΓòÉΓòÉΓòÉ
  1706.  
  1707. The list sub-menu allows you to mark a variety of lists in your document. 
  1708. Simple, ordered, unordered, and definition lists may be marked.  Each list may 
  1709. also be marked as compact or normal depending on how you wish the list to be 
  1710. displayed. 
  1711.  
  1712. The following lists are supported: 
  1713.  
  1714. o Parameter Lists 
  1715. o Definition Lists 
  1716. o Ordered Lists 
  1717. o Unordered Lists 
  1718. o Simple Lists 
  1719.  
  1720. Tagging Information 
  1721.  
  1722. If you separate each item in your list with a blank line each item will 
  1723. automatically be tagged with a list item for you (:li.). 
  1724.  
  1725.  
  1726. ΓòÉΓòÉΓòÉ 8.15.1. Compact Lists Information ΓòÉΓòÉΓòÉ
  1727.  
  1728. This attribute allows you to cause a list to be compacted (removes blank lines 
  1729. between list items).  The following is a standard unordered list: 
  1730.  
  1731. o 101 Dalmations 
  1732.  
  1733. o Dumbo 
  1734.  
  1735. o Beauty and the Beast 
  1736.  
  1737. o Little Mermaid 
  1738.  
  1739. This is the same list, compacted: 
  1740.  
  1741. o 101 Dalmations 
  1742. o Dumbo 
  1743. o Beauty and the Beast 
  1744. o Little Mermaid 
  1745.  
  1746. Note:  You must select the compact option before marking a list since this is a 
  1747. modifier to the standard list commands. 
  1748.  
  1749.  
  1750. ΓòÉΓòÉΓòÉ 8.15.2. Definition Lists Information ΓòÉΓòÉΓòÉ
  1751.  
  1752. This submenu lets you create definition lists. 
  1753.  
  1754.  
  1755. ΓòÉΓòÉΓòÉ 8.15.2.1. Definition List Information ΓòÉΓòÉΓòÉ
  1756.  
  1757. The definition list tag allows you to tag selected text as a definition list. 
  1758. A definition list is a list of terms and their meanings. 
  1759.  
  1760. To make use of this you must have text tagged with the term-heading tag and 
  1761. description heading tag, as well as text tagged with the term and description 
  1762. tags. 
  1763.  
  1764. The following shows the tagging for a simple definition table: 
  1765.  
  1766.     :dl tsize=20.
  1767.     :dthd.Function Name
  1768.     :ddhd.Purpose
  1769.     :dt.ScreenErase()
  1770.     :dd.Erase the display screen
  1771.     :dt.ScreenWrite()
  1772.     :dd.Write data to screen
  1773.     :edl.
  1774.  
  1775. which will be displayed as: 
  1776.  
  1777. Function Name       Purpose 
  1778.  
  1779. ScreenErase()       Erase the display screen 
  1780.  
  1781. ScreenWrite()       Write data to screen 
  1782.  
  1783.  
  1784. ΓòÉΓòÉΓòÉ 8.15.2.2. Definition Term Heading ΓòÉΓòÉΓòÉ
  1785.  
  1786. Use this to mark the heading describing the definition term column. 
  1787.  
  1788.  
  1789. ΓòÉΓòÉΓòÉ 8.15.2.3. Definition Description Heading ΓòÉΓòÉΓòÉ
  1790.  
  1791. Use this to mark the heading describing the definition description column. 
  1792.  
  1793.  
  1794. ΓòÉΓòÉΓòÉ 8.15.2.4. Definition Term ΓòÉΓòÉΓòÉ
  1795.  
  1796. This is used to mark the definition term being defined. 
  1797.  
  1798.  
  1799. ΓòÉΓòÉΓòÉ 8.15.2.5. Definition Description ΓòÉΓòÉΓòÉ
  1800.  
  1801. This is used to mark the definition description associated with the preceding 
  1802. definition term. 
  1803.  
  1804.  
  1805. ΓòÉΓòÉΓòÉ 8.15.3. Parameter List Menu Information ΓòÉΓòÉΓòÉ
  1806.  
  1807. This submenu provides you with the options to create parameter lists. 
  1808.  
  1809.  
  1810. ΓòÉΓòÉΓòÉ 8.15.3.1. Parameter List Definition ΓòÉΓòÉΓòÉ
  1811.  
  1812. This lets you create a parameter list.  The following shows a simple parameter 
  1813. list tagging: 
  1814.  
  1815.     :parml  tsize=20.
  1816.     :pt.Parm1
  1817.     :pd.Description of Parm1
  1818.     :pt.Parm2
  1819.     :pd.Description of Parm2
  1820.     :eparml.
  1821.  
  1822. which is displayed as follows: 
  1823.  
  1824. Parm1 
  1825.                     Description of Parm1 
  1826.  
  1827. Parm2 
  1828.                     Description of Parm2 
  1829.  
  1830. This was created by placing the parameter term (Parm1 and Parm2) on separate 
  1831. lines with the parameter descriptions on the lines immediately following them. 
  1832. The entire section was then marked as a parameter list.  Terms are marked using 
  1833. the Parameter List Term tag  and the definitions with the Parameter List 
  1834. Description tag. 
  1835.  
  1836.  
  1837. ΓòÉΓòÉΓòÉ 8.15.3.2. Parameter List Term ΓòÉΓòÉΓòÉ
  1838.  
  1839. This marks the term that will be defined in the parameter list. 
  1840.  
  1841.  
  1842. ΓòÉΓòÉΓòÉ 8.15.3.3. Parameter List Definition ΓòÉΓòÉΓòÉ
  1843.  
  1844. This defines the definition of a parameter in a parameter list. 
  1845.  
  1846.  
  1847. ΓòÉΓòÉΓòÉ 8.15.4. Ordered Lists Information ΓòÉΓòÉΓòÉ
  1848.  
  1849. This creates an ordered list from selected text.  The following shows the 
  1850. tagging for an ordered list using the following names: 
  1851.  
  1852.     :ol.
  1853.     :li.Zoe
  1854.     :li.Delaine
  1855.     :li.Danika
  1856.     :li.Brent
  1857.     :li.Bill
  1858.     :eol.
  1859.  
  1860. which displays as follows: 
  1861.  
  1862.  1. Zoe 
  1863.  
  1864.  2. Delaine 
  1865.  
  1866.  3. Danika 
  1867.  
  1868.  4. Brent 
  1869.  
  1870.  5. Bill 
  1871.  
  1872. Tagging Information 
  1873.  
  1874. If you separate each item in your list with a blank line each item will 
  1875. automatically be tagged with a list item (:li.). 
  1876.  
  1877. Note:  Ordered lists are similar to unordered lists but have a numbered item 
  1878. for each element in the list. 
  1879.  
  1880.  
  1881. ΓòÉΓòÉΓòÉ 8.15.5. Unordered Lists Information ΓòÉΓòÉΓòÉ
  1882.  
  1883. This creates an unordered list.  The following shows an unordered list as it is 
  1884. tagged: 
  1885.  
  1886.     :ul.
  1887.     :li.One
  1888.     :li.Three
  1889.     :li.Two
  1890.     :eul.
  1891.  
  1892. which will look like the following: 
  1893.  
  1894. o One 
  1895.  
  1896. o Three 
  1897.  
  1898. o Two 
  1899.  
  1900. Tagging Information 
  1901.  
  1902. If you separate each item in your list with a blank line each item will 
  1903. automatically be tagged with a list item (:li.). 
  1904.  
  1905.  
  1906. ΓòÉΓòÉΓòÉ 8.15.6. Simple Lists Information ΓòÉΓòÉΓòÉ
  1907.  
  1908. This causes selected text to be tagged as a simple list.  The following tags 
  1909. create a simple list: 
  1910.  
  1911.     :sl.
  1912.     :li.Dog
  1913.     :li.Cat
  1914.     :li.Rabbit
  1915.     :esl.
  1916.  
  1917. which generates: 
  1918.  
  1919. Dog 
  1920.  
  1921. Cat 
  1922.  
  1923. Rabbit 
  1924.  
  1925. Tagging Information 
  1926.  
  1927. If you separate each item in your list with a blank line each item will 
  1928. automatically be tagged with a list item (:li.). 
  1929.  
  1930.  
  1931. ΓòÉΓòÉΓòÉ 8.15.7. List Item Information ΓòÉΓòÉΓòÉ
  1932.  
  1933. This is used to tag an item in a list.  This tag works with any of the standard 
  1934. lists.  The following list of names has each named tagged with :li.: 
  1935.  
  1936.     :ul.
  1937.     :li.Mario
  1938.     :li.Mom
  1939.     :li.Dad
  1940.     :eul.
  1941.  
  1942. which generates the following: 
  1943.  
  1944. o Mario 
  1945.  
  1946. o Mom 
  1947.  
  1948. o Dad 
  1949.  
  1950. The :li. were entered using list item command.  The :ul. and :eul. were 
  1951. generated using the unordered list command. 
  1952.  
  1953. Note:  You can press ALT-L to quickly insert the :li. symbol. 
  1954.  
  1955. Note:  If you separate each list item with a blank line before marking the list 
  1956.        the IPF Editor will automatically generate the list items for you. 
  1957.  
  1958.  
  1959. ΓòÉΓòÉΓòÉ 8.15.8. List Paragraph Information ΓòÉΓòÉΓòÉ
  1960.  
  1961. This allows you to insert the list paragraph tag into a list of items.  With 
  1962. this tag you can easily create a list of paragraphs that are automatically 
  1963. formatted.  The following shows an unordered list with list paragraphs: 
  1964.  
  1965.     :ul.
  1966.     :li.This is a list item.
  1967.     :lp.This is the first paragraph in the list and can be as many lines are you like.
  1968.     :lp.This is the second paragraph in the list associated with the first list item.
  1969.     :li.This is another list item (:li.).
  1970.     :eul.
  1971.  
  1972. which generates the following list: 
  1973.  
  1974. o This is a list item. 
  1975.  
  1976.   This is the first paragraph in the list and can be as many lines are you 
  1977.   like. 
  1978.  
  1979.   This is the second paragraph in the list associated with the first list item. 
  1980.  
  1981. o This is another list item (:li.). 
  1982.  
  1983.  
  1984. ΓòÉΓòÉΓòÉ 8.16. Lines Information ΓòÉΓòÉΓòÉ
  1985.  
  1986. The Lines option lets you show text in the help manager exactly as you type it 
  1987. in the editor.  The following text shows how to use this command: 
  1988.  
  1989.     :lines align=center.
  1990.     The
  1991.          dog
  1992.                ran
  1993.                    by.
  1994.     :elines.
  1995.  
  1996. which generates the following: 
  1997.  
  1998.                                        The
  1999.                                         dog
  2000.                                           ran
  2001.                                            by.
  2002.  
  2003.  
  2004. ΓòÉΓòÉΓòÉ 8.17. Font Information ΓòÉΓòÉΓòÉ
  2005.  
  2006. This menu option provides a method for changing the displayed font type and 
  2007. size in your document. To adjust the attributes of text, see the Highlighting 
  2008. options. 
  2009.  
  2010. The following shows setting a list of names in monospaced text: 
  2011.  
  2012.     :font facename='System Monospaced' size=20x10.
  2013.     :ul.
  2014.     :li.Bill
  2015.     :li.Delaine
  2016.     :li.Danika
  2017.     :eul.
  2018.     :font facename='default'.
  2019.  
  2020. which displays as the following: 
  2021.  
  2022. o Bill 
  2023.  
  2024. o Delaine 
  2025.  
  2026. o Danika 
  2027.  
  2028. The text is restored to the system default font after the marked text is set to 
  2029. the desired font. 
  2030.  
  2031.  
  2032. ΓòÉΓòÉΓòÉ 8.18. Margin Information ΓòÉΓòÉΓòÉ
  2033.  
  2034. The Margin submenu allows you to set the left and right margins for you 
  2035. document. 
  2036.  
  2037.  
  2038. ΓòÉΓòÉΓòÉ 8.18.1. Left Margin Information ΓòÉΓòÉΓòÉ
  2039.  
  2040. This allows you to specify the left margin for your document.  The following 
  2041. shows normal paragraphs with the left margin set to 15 
  2042.  
  2043.     :lm margin=15.
  2044.     :p.This has a left margin of 15
  2045.     :lm margin=1.
  2046.  
  2047. which generates: 
  2048.  
  2049.                This has a left margin of 15 
  2050.  
  2051.  The left margin is restored to 1 when we are finished with it so all further 
  2052.  text will be normal. 
  2053.  
  2054.  
  2055. ΓòÉΓòÉΓòÉ 8.18.2. Right Margin Information ΓòÉΓòÉΓòÉ
  2056.  
  2057. This allows you to specify the right margin for your document.  The following 
  2058. sets the right margin to 20. 
  2059.  
  2060.     :lm margin=1.
  2061.     :rm margin=20.
  2062.     :p.This has a right margin of 20
  2063.  
  2064. which will output: 
  2065.  
  2066.  This has a right margin of 20 and a left margin of 1. 
  2067.  
  2068.  
  2069. ΓòÉΓòÉΓòÉ 8.19. HyperText/Graphics Link Information ΓòÉΓòÉΓòÉ
  2070.  
  2071. The HyperText/Graphics Link menu option lets you create hypertext/graphics 
  2072. links from one part of your document to another. Hypertext/Graphics links can 
  2073. only be made to items tagged using the Header command or the footnotes command. 
  2074.  
  2075. Generally, you will not need to manually mark text and link it using this 
  2076. command if you use the auto-link option in the Application menu (it will 
  2077. automatically generate all links to headers and footnotes as they are 
  2078. encountered in your project). 
  2079.  
  2080. Tagging Information 
  2081.  
  2082.  Mark the selected text then select the hypertext/graphics menu item or  menu 
  2083. item. 
  2084.  
  2085. Note:  Hyper-links can only be made to panel headings levels 1 through 4. 
  2086.  
  2087.  
  2088. ΓòÉΓòÉΓòÉ 8.20. Index Information ΓòÉΓòÉΓòÉ
  2089.  
  2090. Use this to add primary or secondary level indices to your document. 
  2091.  
  2092. When you generate a primary index entry you will specify the "root words." 
  2093. "Root words" are the key words used by index synonyms, which are created 
  2094. automatically when you create an index entry. 
  2095.  
  2096. You must also supply the description entry to place into the index. This is a 
  2097. short text description which is what you will see in the index. 
  2098.  
  2099. Indices also require an ID, which is a brief text label used to link secondary 
  2100. and primary indices.  The default ID is the first three characters of the 
  2101. descriptio entry. 
  2102.  
  2103.  
  2104. ΓòÉΓòÉΓòÉ 8.20.1. Index Creation ΓòÉΓòÉΓòÉ
  2105.  
  2106. This page allows you to create indices in your document or index synonyms. 
  2107. This index entry will appear when the user selects the Help index from the help 
  2108. menu (or the from the options menu if in the VIEW.EXE program). 
  2109.  
  2110.  
  2111. ΓòÉΓòÉΓòÉ 8.20.1.1. Index Description ΓòÉΓòÉΓòÉ
  2112.  
  2113. Place the index description in this field.  If you leave this field blank a 
  2114. synonym tag only will be created, but no new index entry. 
  2115.  
  2116.  
  2117. ΓòÉΓòÉΓòÉ 8.20.1.2. Index Level 1 ΓòÉΓòÉΓòÉ
  2118.  
  2119. Selecting this will generate a primary index. 
  2120.  
  2121.  
  2122. ΓòÉΓòÉΓòÉ 8.20.1.3. Index Level 2 ΓòÉΓòÉΓòÉ
  2123.  
  2124. Selecting this will generate a secondary index. 
  2125.  
  2126.  
  2127. ΓòÉΓòÉΓòÉ 8.20.1.4. Index Root(s) ΓòÉΓòÉΓòÉ
  2128.  
  2129. This field contains the roots for primary index entries or the root for a 
  2130. secondary index entry. 
  2131.  
  2132. Root words (roots) are index entries to specified topics.  These root words are 
  2133. associated with words defined with the index-synonyms. Root words can contain 
  2134. alphabetic and numeric characters, and can be upper or lower case.  When 
  2135. entering more than one root word place a space between each word. 
  2136.  
  2137. A root word in a synonym only creation is used to link to the primary index or 
  2138. secondary index entry. 
  2139.  
  2140.  
  2141. ΓòÉΓòÉΓòÉ 8.20.1.5. Index ID or Ref ID ΓòÉΓòÉΓòÉ
  2142.  
  2143. This field contains the identifier for the primary index, or the reference 
  2144. indentifier for secondary index entries.  ID and reference ID's are used to 
  2145. link primary and secondary index entries. 
  2146.  
  2147.  
  2148. ΓòÉΓòÉΓòÉ 8.20.1.6. Index Synonym Text ΓòÉΓòÉΓòÉ
  2149.  
  2150. Enter the text for synonyms for this index. 
  2151.  
  2152.  
  2153. ΓòÉΓòÉΓòÉ 8.21. Symbols Information ΓòÉΓòÉΓòÉ
  2154.  
  2155. This allows you to select from a list of commonly used symbols for use in your 
  2156. document. Some of the many symbols available are as show below: 
  2157.  
  2158.  : - Colon 
  2159.  ┬░ - Degree symbol 
  2160.  ╤ü - Beta symbol 
  2161.  ╨╝ - 1/4th symbol 
  2162.  
  2163.  These symbols can be quickly placed into your text using the ALT-S command. 
  2164.  
  2165.  
  2166. ΓòÉΓòÉΓòÉ 8.21.1. Symbol List ΓòÉΓòÉΓòÉ
  2167.  
  2168. This list provides you with the most common symbols supported by the IPF 
  2169. system. You may double click on an item or single click and then press 
  2170. "Select." 
  2171.  
  2172.  
  2173. ΓòÉΓòÉΓòÉ 8.21.2. Symbol List Select ΓòÉΓòÉΓòÉ
  2174.  
  2175. Pressing this button, once you have selected a symbol from the symbol list, 
  2176. will cause the symbol to be placed directly into your IPF document. 
  2177.  
  2178.  
  2179. ΓòÉΓòÉΓòÉ 8.22. Group Panel Headings ΓòÉΓòÉΓòÉ
  2180.  
  2181. This option will allow you to group selected headings together, displaying them 
  2182. on the same visible page.  This means that whatever panels headings you have 
  2183. selected will share the displayed View or Help Manager window.  Normally when a 
  2184. panel is displayed it replaces any previous panels shown.  With this option you 
  2185. can easily and quickly provide multiple panels, each with related information. 
  2186. The IPF system refers to this as the Viewport.  Of course you can still 
  2187. manually tag groups of headers together, but using the predefined types of 
  2188. header groupings saves a tremendous amount of time. 
  2189.  
  2190.  
  2191. ΓòÉΓòÉΓòÉ 8.22.1. Panel Heading Group Type ΓòÉΓòÉΓòÉ
  2192.  
  2193. Select the type of panel header grouping you wish to include in your document 
  2194. for the marked headers.  If you try to select a grouping that requires more 
  2195. panel headers than you have marked, you will receive an warning message and not 
  2196. be allowed to select it. 
  2197.  
  2198. The following panel header groupings are supported: 
  2199.  
  2200.  o The  selection will create a single panel that will be overlaid (not 
  2201.    replaced) by the second panel selected.  This will allow you to have two 
  2202.    panels active that both fill the entire display area. 
  2203.  
  2204.  o The  selection will create a two panels that will share the display 
  2205.    equally.The second window will not be shown until the user selects the 
  2206.    hyperlink to it. 
  2207.  
  2208.  o The  selection will group three panels side by side, each using 1/3rd of the 
  2209.    display.  The second window will not be shown until the user selects the 
  2210.    hyperlink to it. 
  2211.  
  2212.  o The  selection group four panels side by side, each using a quarter of the 
  2213.    display.  The second window will not be shown until the user selects the 
  2214.    hyperlink to it. 
  2215.  
  2216.  o The  will place two headers in the display area, one on top of the other. 
  2217.    The second window will not be shown until the user selects the hyperlink to 
  2218.    it. 
  2219.  
  2220.  o The  will provide a parent panel along with multiple child windows, with 
  2221.    each successive child window replacing the previous child window on the 
  2222.    right side.  The second window(s) will not be shown until the user selects 
  2223.    the hyperlink to it. 
  2224.  
  2225.  o The  will generate two panels, side by side, that both appear immediately 
  2226.    when the first is selected. 
  2227.  
  2228.  o The  will generate three panels, each using 1/3rd of the display, that will 
  2229.    appear when the parent window is selected. 
  2230.  
  2231.  o The  will generate four panels, each using 1/4th of the display, that will 
  2232.    appear when the parent window is selected. 
  2233.  
  2234.  o The  will generate two panels, with the parent on top and the child below 
  2235.    it, with both of them appearing when the parent is displayed. 
  2236.  
  2237.  
  2238. ΓòÉΓòÉΓòÉ 8.22.2. Hide Child Panels ΓòÉΓòÉΓòÉ
  2239.  
  2240. Selecting this will cause any child panels (any panel except the first panel 
  2241. marked is considered to be a child panel) to be hidden until its hyperlink is 
  2242. activated. 
  2243.  
  2244.  
  2245. ΓòÉΓòÉΓòÉ 8.22.3. Select Group Headers Type ΓòÉΓòÉΓòÉ
  2246.  
  2247. Pushing this inserts the commands to generate the desired grouping into your 
  2248. document. 
  2249.  
  2250.  
  2251. ΓòÉΓòÉΓòÉ 9. Final Caveats ΓòÉΓòÉΓòÉ
  2252.  
  2253. Special thanks for testing and debugging, and putting up with the work involved 
  2254. in this, to: 
  2255.  
  2256.  o Mario Perez III ("Gee, does it work right now?", "It sure would be nice if 
  2257.    it would...", and "This isn't right, is it?") 
  2258.  
  2259.  o Mario Perez Jr. ("That works pretty well except for..." and "Where's the 
  2260.    multi-tasking?  Add a thread here...") 
  2261.  
  2262.  o D.M.B. ("Are you done working on that program yet...") 
  2263.  
  2264.  o D.A.B. ("I want to push the button!") 
  2265.  
  2266.  o Brent Anderson ("Biking in mud's a lot more fun than programming...Let's 
  2267.    go!") 
  2268.  
  2269.  
  2270. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2271.  
  2272. Perez Computing Services (PCS) is a software development company consisting of 
  2273. Mario Perez Jr. and Bill Perez.  We have over forty years of programming 
  2274. experience between us and have written numerous applications for DOS, Windows, 
  2275. and OS/2.  We provide custom programming as well as having several retail OS/2 
  2276. and DOS software packages available. 
  2277.  
  2278. If you wish to contact us you may via U.S. mail or Compuserve, Prodigy, or 
  2279. IBMLINK's OS/2 BBS.  Please make all contacts "attention Bill Perez." 
  2280.  
  2281.  
  2282. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2283.  
  2284. The Information Presentation Facility Guide is available from IBM either as 
  2285. part of the OS/2 2.x Technical Library or separately.  You can contact IBM at 
  2286. 1-800-3-IBM-OS2 to order it. 
  2287.  
  2288.  
  2289. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2290.  
  2291. IBM and OS/2 are registered trademarks of International Business Machines 
  2292. Corporation. 
  2293.  
  2294.  
  2295. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2296.  
  2297. Marked text is text you have selected by placing the cursor at it's beginning 
  2298. and highlighted by pressing the left mouse button and dragging the pointer over 
  2299. the text. 
  2300.  
  2301.  
  2302. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  2303.  
  2304. This is a footnote.