home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ipf12d.zip / IPFBLDER.HLP (.txt) < prev    next >
OS/2 Help File  |  1994-09-18  |  152KB  |  798 lines

  1.  
  2. ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
  3.  
  4. Custom Design Software's 
  5.  
  6. IPF Builder - Online Help 
  7.  
  8. IPF Builder is a program that will assist you in the creation of IPF files. 
  9. These files can then be either compiled into INF files or online help files. 
  10.  
  11. One of the hardest jobs when it comes to creating IPF files is remembering the 
  12. numerous formatting codes you need to insert in your text as you create these 
  13. files. IPF Builder eases this job considerably. 
  14.  
  15. Even harder is to keep track of the various headers you've created and building 
  16. the hypertext links that allow a user to quickly move from one heading to 
  17. another. Again, IPF Builder assists greatly in this task. 
  18.  
  19. Although IPF Builder will not give you the ability to use all of the various 
  20. formatting options available to you with IPFC, it does give you enough to 
  21. create some pretty decent INF and HLP files. See Changes from Previous versions 
  22. for information on how the program has been updated from the previous version. 
  23.  
  24. For information on the restrictions of use with the DEMO VERSION of IPF Builder 
  25. see Notes on the Demo Version. 
  26.  
  27. Double click on one of the topics below for more information. Especially 
  28. important is understanding the process you'll need to use to create a new IPF 
  29. file. 
  30.  
  31. Γûá Getting Started
  32. Γûá Saving Your Work
  33. Γûá Creating a Header
  34. Γûá Creating Links
  35. Γûá Testing your work as you go.
  36. Γûá Editing Controls
  37. Γûá Using Bullets
  38. Γûá Highlighting Text
  39. Γûá Fonts
  40. Γûá Bold Text
  41. Γûá Inserting a BMP
  42. Γûá Changing Margins
  43. Γûá Adding Text from another file
  44. Γûá Popup Menu for Quick Access
  45. Γûá Creating Lists
  46. Γûá Changing Colors
  47. Γûá Creating Footnotes
  48. Γûá Closing a File
  49. Γûá IPFC Context Sensitive Help
  50. Γûá Create a Table
  51. Γûá User Installable Tags
  52. Γûá Getting a Tree View of your IPF file.
  53. Γûá System Requirements
  54. Γûá Technical Support
  55.  
  56.  
  57. ΓòÉΓòÉΓòÉ 1.1. Changes from Previous versions ΓòÉΓòÉΓòÉ
  58.  
  59. Changes from Version 1.0: 
  60.  
  61.  Due to user requests IPF Builder has eliminated many of the buttons that were 
  62. contained in Version 1.0. Having these buttons was redundant since the menu bar 
  63. and popup menu offered all the capabilities plus more. This makes for a less 
  64. cluttered interface. The following new features have been added: 
  65.  
  66.  1. Editing window is not displayed until a new IPF File is created or an 
  67.     existing one is loaded. 
  68.  2. Once you are editing an IPF file, you cannot create a new one or load an 
  69.     existing one. These menu items are greyed out. 
  70.  3. "Edit", "Actions" and "Compile" on menu bar are disabled until an IPF file 
  71.     is created or opened. 
  72.  4. The ability to create Footnotes and link to them. 
  73.  5. Addition of variously formatted Lists. 
  74.  6. Addition of color tags. 
  75.  7. Addition of "break" and "warning" tags. 
  76.  8. Addition of "caution" tag. 
  77.  9. Addition of "Note (single paragraph)" tag. 
  78. 10. Checks for selected text when applying tags that depend on first selecting 
  79.     the text to tag. 
  80. 11. Addition of a horizontal scroll bar in the edit window. 
  81. 12. Queries you if you want to Save your file when Exiting to remind you to 
  82.     save your work. 
  83. 13. Commenting when adding New Headings so that finding the sections is alot 
  84.     easier. 
  85. 14. Updated Online Help to reflect the changes made in this new version. 
  86.  
  87.  Changes from Version 1.1: 
  88.  
  89. Version 1.11 incorporates the following changes and enhancements: 
  90.  
  91.  1. IPF Files that you are editing can now be Closed and a new one created or 
  92.     opened. It is no longer a requirement that the program be stopped and 
  93.     started again to deal with another IPF file. 
  94.  2. Context sensitive help for the IPFC online help is now incorporated making 
  95.     it easy to find specific information on the IPFC tagging language. See IPFC 
  96.     Context Sensitive Help 
  97.  3. Since some large IPF files can take a long time to compile, IPF Builder now 
  98.     informs you that the compile process has started in the background. 
  99.  4. VIEWINF.CMD has been changed to accomodate a second parameter. 
  100.  5. A "Find" text feature that allows you to quickly find a text string in your 
  101.     IPF file. 
  102.  
  103. Changes from Version 1.11: 
  104.  
  105. Version 1.12 incorporates the following changes and enhancements: 
  106.  
  107.  1. Loading an IPF File into the editing window has been speeded up 300% by 
  108.     making the editing window visible after the IPF File is loaded into memory. 
  109.  2. After an IPF File is loaded the cursor returns to the top of the file 
  110.     rather than remaining at the end of the file. 
  111.  3. The menu bar has been changed so that "View" replaces "View INF". A 
  112.     pull-down menu under "View" now allows the user to view either INF or HLP 
  113.     files. See Testing your work as you go. for more information on viewing INF 
  114.     and HLP files from within IPF Builder. 
  115.  4. When creating a new heading and you forget to choose the heading level, IPF 
  116.     Builder now defaults to a heading level of 1. See Creating a Header. 
  117.  5. "Large Font" has been replaced with a "Fonts..." dialog box that allows you 
  118.     to select between Courier, Times Roman, Helvetica and default fonts along 
  119.     with selecting the point size of the font you want. See Fonts for more 
  120.     information on using the Fonts tag. 
  121.  6. Level 1 headings can now be indexed. See Creating a Header for more 
  122.     information. 
  123.  7. When inserting BMP files into your IPF file, IPF Builder now displays the 
  124.     BMP file that you've selected. See Inserting a BMP for more information. 
  125.  8. Now you can create Tables in your IPF files using IPF Builder. See Create a 
  126.     Table for more information. 
  127.  9. The online help files IPFBLDER.HLP and IPFBLDER.INF have been updated to 
  128.     reflect all new features and changes. 
  129.  
  130. Changes from Version 1.12: 
  131.  
  132. The MAJOR CHANGE with this version of IPF Builder is a DRAMATIC increase in 
  133. speed in the operation of the program. 
  134.  
  135.  Version 1.2 incorporates the following changes and enhancements: 
  136.  
  137.  1. Now you can customize IPF Builder by creating your own additions to the 
  138.     pop-up menu. See User Installable Tags for more information. 
  139.  
  140.  2. You can now get a graphical representation of the structure of your IPF 
  141.     file. See Getting a Tree View of your IPF file. for more information. 
  142.  
  143.  3. The file COMPILE.CMD is no longer required. IPF Builder creates its own CMD 
  144.     files each time it compiles either an INF or HLP file. Version 1.2 is able 
  145.     to operate much more smoothly when a compilation is taking place in the 
  146.     background. See Testing your work as you go. for more information on the 
  147.     compiling process. 
  148.  
  149.  4. The layout of IPF Builder has been changed. The editing area now sits in a 
  150.     window centered in the main IPF Builder window. The editing area can be 
  151.     re-sized along with the main window allowing you to size the window to the 
  152.     most comfortable size for your needs. 
  153.  
  154.  5. The file you are editing is now displayed on the title bar of the editing 
  155.     window and the "Save IPF File" button has been removed. See Saving Your 
  156.     Work for more information on saving your IPF files. 
  157.  
  158.  6. Speed enhancements have been obtained in the program by using VX*REXX 
  159.     version 2.1. The previous versions of VX*REXX had a bug in the cursor 
  160.     positioning in a multiline entry field that caused the slow "Find" 
  161.     procedure. Because IPF Builder is now compiled with version 2.1 the 
  162.     VROBJ.DLL runtime file has also been upgraded and replaces the previous 
  163.     VROBJ.DLL that came with earlier versions of IPF Builder. 
  164.  
  165.  7. The online help files IPFBLDER.HLP and IPFBLDER.INF have been changed to 
  166.     reflect all new features and changes. 
  167.  
  168. Return to Introduction 
  169.  
  170.  
  171. ΓòÉΓòÉΓòÉ 1.2. Notes on the Demo Version ΓòÉΓòÉΓòÉ
  172.  
  173. The DEMO VERSION of IPF Builder is functional in all aspects with the following 
  174. exceptions: 
  175.  
  176. o You cannot save the IPF file that you are editing. 
  177. o You cannot "Copy" text from the IPF file to the OS/2 Clipboard (as this would 
  178.   allow you to save your text) longer than 100 characters. 
  179. o You cannot "Cut" text from the IPF file (for the same reason). 
  180. o If you have created a new file with this demo version, you will not be able 
  181.   to save it. Therefore you will not be able to "Compile" this file into an INF 
  182.   or HLP file. If you want to test the "Compile" functions, load an existing 
  183.   IPF file. You'll then be able to "Compile" it into either an INF or HLP file. 
  184.   Any changes you make to the file will not be saved however. We suggest that 
  185.   you use a copy of your original IPF file to use with this demo version. 
  186.  
  187.  Return to Introduction 
  188.  
  189.  
  190. ΓòÉΓòÉΓòÉ 2. Getting Started ΓòÉΓòÉΓòÉ
  191.  
  192. Click on "File" on the menu bar, then "New File" to start the creation of a new 
  193. IPF file. You'll be asked to input the name of the IPF file. (Include the "IPF" 
  194. extention) and to give a Title to the new document. (This Title will be 
  195. displayed on the main INF window when you later VIEW it.) 
  196.  
  197. The first thing you should do when creating a new IPF file is take note of the 
  198. fact that IPF Builder will create level 1, 2 and 3 headings with the formatting 
  199. code of :h1. and :h2. and :h3. 
  200.  
  201. Secondly, when you first start creating your new IPF file you'll see that an 
  202. "Introduction" heading is automatically created and assigned a resource ID of 
  203. "10000". All additional resource ID's for the new headings you create need to 
  204. have unique numbers. You should consider continuing with the resource ID's so 
  205. that your next heading will be assigned "10001" and the one after that "10003", 
  206. etc. 
  207.  
  208. Here is what is first created when you start working on a new IPF file: 
  209.  
  210.      :*
  211.      :userdoc.
  212.      :title.Title of INF or HLP Document
  213.      :docprof toc=123.
  214.      .*****************************************************************************************
  215.      .*                            Introduction        [  10000  ]
  216.      .*****************************************************************************************
  217.      :h1 res=10000.Introduction
  218.  
  219.  
  220.  
  221.  
  222.      .********************************[ End of IPF ]*****************************************
  223.      :euserdoc.
  224.  
  225. You'll want to make sure that your IPF document ends with ":euserdoc." so don't 
  226. enter in text beyond this point in your IPF file. 
  227.  
  228. You should start creating your documentation by first creating new headings and 
  229. entering text under each heading. After you've created all your headings and 
  230. entered all the text under each heading you can then go back to your 
  231. Introduction and create the links to each heading. 
  232.  
  233. IPF Builder looks for :h1. headings to get a listing of the headings in your 
  234. document to display in a list box when you click on the "Link" button. If the 
  235. headings are not created first prior to trying to link to them, IPF Builder 
  236. will not be able to find them of course and no link can take place. 
  237.  
  238. Since :h1 res=10000.Introduction is created automatically at the beginning of 
  239. IPF file creation, you can always link a return to the starting point of your 
  240. document anytime you are creating new headings and their respective text. See 
  241. below: 
  242.  
  243. Return to Introduction 
  244.  
  245.  
  246. ΓòÉΓòÉΓòÉ 3. Saving Your Work ΓòÉΓòÉΓòÉ
  247.  
  248. It is important that you save your work on a regular basis as you develop your 
  249. IPF document. Prior to Compiling an INF or HLP file, you should make sure that 
  250. you've saved the IPF file that you are working on. Click on "File" "Save File" 
  251. from the menu bar to save the file you are editing. 
  252.  
  253. Return to Introduction 
  254.  
  255.  
  256. ΓòÉΓòÉΓòÉ 4. Creating a Header ΓòÉΓòÉΓòÉ
  257.  
  258. When you start creating your IPF file the first thing you should do is start by 
  259. creating the various Headings and accompanying text. (You can always go back 
  260. and add text later or change the formatting of the text). 
  261.  
  262. Click on "Actions" "Create New Heading" on the menu bar or click mouse button 2 
  263. and "Create New Heading". You'll be asked to enter the text of the Heading and 
  264. assign a resource ID to the heading. Resource ID's should be entered in up to 5 
  265. digits, as in: "10003". You also need to select a heading level. Levels can be 
  266. 1, 2 or 3. 
  267.  
  268. The heading will be inserted into your IPF file at the position of your cursor. 
  269. So you'll want to make sure your cursor is located on a new line in column one. 
  270. Here is an example of a header: 
  271.  
  272.      :h1 res=10004.Creating a Header
  273.      :p.
  274.  
  275. The line above creates the heading for this section of the HLP file you are 
  276. presently reading. In fact, this whole document was created using IPF Builder 
  277. and all that you see here can be duplicated by yourself when you create your 
  278. IPF files using IPF Builder. 
  279.  
  280. Level 1 headings can also be indexed. When creating a Level 1 heading, IPF 
  281. Builder will ask you if you want to index this heading. If you click on "OK" 
  282. the following will be inserted into your IPF file: 
  283.  
  284.      :h1 res=10004.Creating a Header
  285.      :i1. Creating a Header
  286.      :p.
  287.  
  288. Note:  Only Level 1 headings can be indexed. 
  289.  
  290. Return to Introduction 
  291.  
  292.  
  293. ΓòÉΓòÉΓòÉ 5. Creating Links ΓòÉΓòÉΓòÉ
  294.  
  295. Links allow you to create hypertext links to quickly move from one section of 
  296. your INF or HLP file to another. IPF Builder creates links that take you to the 
  297. various Headers that you've created. It is important to create the Headings 
  298. prior to trying to link to them. Although this is the recommended procedure, 
  299. you can still develop your IPF file by jumping back and forth and creating 
  300. headings and links as you go along. 
  301.  
  302. To create a Link, click on "Actions" "Link to Heading/Footnote". This will 
  303. display the headings and footnotes that you've presently got in your IPF file 
  304. and you can select the heading you wish to create a link to. 
  305.  
  306. Clicking on the menu bar as described above opens a Notebook view of all the 
  307. headers in your document. 
  308.  
  309. Note: 
  310.  
  311.  A quick way to get to the Notebook headings list is to click the Right Mouse 
  312. Button. This will open a popup window that will allow you to get quickly to any 
  313. of the IPF Controls. See Popup Menu for Quick Access 
  314.  
  315. If you selected "Introduction" for example, the following line would be 
  316. inserted into your IPF file: 
  317.  
  318.      :link reftype=hd res=10000.Introduction:elink.
  319.  
  320. The headings are divided up based on the Level that you originally assigned to 
  321. them. Any heading and its text with a Level of 2 for example would be a child 
  322. of the Level 1 heading immediately preceding it. When you start developing a 
  323. document with more than one level of headings you want to make sure that you 
  324. use a numbering scheme that will make it easy for you to locate the lower 
  325. levels. 
  326.  
  327. Clicking on one of the Tabs will display all the headings you've created with 
  328. Level 1 (One), Level 2 (Two), or Level 3 (Three) 
  329.  
  330. Links can be inserted anywhere in your IPF file. So to create the line "Return 
  331. to Introduction", you'd type in "Return to ", then click on "Actions" "Link to 
  332. Heading/Footnote" and then select "10000.Introduction" by clicking on it. Once 
  333. "10000.Introduction" is highlighted, click on the "Select" Button . The result 
  334. would be what you see below: 
  335.  
  336. Return to Introduction 
  337.  
  338. You can also link to a footnote that you've created. To link to a footnote you 
  339. need to: 
  340.  
  341. o Make sure you've created a footnote that you wish to link to. 
  342. o Highlight the word or phrase you want to link to a footnote. 
  343. o Click on "Actions" "Link to Heading/Footnote" on the menu bar or use the 
  344.   popup menu. 
  345. o Click on the "Footnotes" tab on the notebook. 
  346. o Click on the footnote you wish to link to. 
  347. o Click on the "Select" Button. 
  348.  
  349. Return to Introduction 
  350.  
  351.  
  352. ΓòÉΓòÉΓòÉ 6. Testing your work as you go. ΓòÉΓòÉΓòÉ
  353.  
  354. As your IPF starts to take shape, you can Compile and View. the resultant INF 
  355. file or HLP file. This makes it very convenient to see just how your finished 
  356. document will look and whether you are getting it all right. 
  357.  
  358. To Compile your work, have a copy of IPFC.EXE located in the same directory as 
  359. IPF Builder. (or in your PATH) Use this directory for saving your IPF files and 
  360. storing the INF and HLP files you are creating. 
  361.  
  362. Click on "File" "Save File"  to make sure the latest version has been saved to 
  363. a file BEFORE trying to Compile a new INF file or HLP file. 
  364.  
  365. Click on "Compile" "INF File" on the menu bar at the top of the screen. 
  366. Compiling may take some time, depending on how long and complex your document 
  367. is. When compiling is started, the VX*REXX Console will become visible on your 
  368. desktop. The Console will display what has happened during the compile stage. 
  369. You can look over the results to see if all compiled alright. Click on the 
  370. VX*REXX Console window to bring it to the front so that you can see the 
  371. results. Keep the Console on-screen so that you can see the results of future 
  372. compiles and know when a compile has been completed. 
  373.  
  374. You will know compilation is complete when you see "Document title : " on the 
  375. top line of the VX*REXX Console. 
  376.  
  377. Once your document has been compiled, you click on "View" from the menu bar to 
  378. launch a VIEW of your newly created INF or HLP file. Now you can go through 
  379. this file and make sure that the IPF file you have created is working as 
  380. expected. 
  381.  
  382. Note:  If you have chosen to View a HLP file you can return to viewing it at 
  383. any time by pressing the F1 function key. If however you've looked at IPF 
  384. Builder's Online Help since viewing the HLP file you are developing, F1 will 
  385. bring up the Online Help, not your HLP file. 
  386.  
  387. This process of Entering Text, Saving IPF, Compiling and Viewing is the basic 
  388. procedure you'll use to develop your online documents. 
  389.  
  390. Return to Introduction 
  391.  
  392.  
  393. ΓòÉΓòÉΓòÉ 7. Editing Controls ΓòÉΓòÉΓòÉ
  394.  
  395. To assist you with the creation of your IPF file, you can: 
  396.  
  397.  1. Undo your last action 
  398.  2. Copy highlighted text to the OS/2 Clipboard 
  399.  3. Paste the contents of the OS/2 Clipboard into your IPF document 
  400.  4. Delete text you've selected in your IPF document 
  401.  5. Cut selected text - use to move text by deleting and then Pasting somewhere 
  402.     else 
  403.  6. Find a text string in your IPF file so that you can quickly move to a 
  404.     specific section of your IPF file. 
  405.  7. Do repeated finds by clicking on "Find Again" after your first "Find". 
  406.  
  407.  Any text that you highlight in the editing window can be copied to the OS/2 
  408. Clipboard by clicking on "Edit" "Copy" on the menu bar. Highlighted text can 
  409. also be cut by clicking on "Edit" "Cut". When text is cut it is deleted from 
  410. the document and placed in the Clipboard so that it can pasted (ie. moved) 
  411. somewhere else. 
  412.  
  413. Any text that is already in the Clipboard, either by copying from your IPF 
  414. document or some other source can be pasted into your IPF document. Place your 
  415. cursor in your document where you want to paste the text and then click on 
  416. "Edit" "Paste" on the menu bar. 
  417.  
  418. Return to Introduction 
  419.  
  420.  
  421. ΓòÉΓòÉΓòÉ 8. Using Bullets ΓòÉΓòÉΓòÉ
  422.  
  423. IPF Builder will let you easily add Bullets to your document. Click on 
  424. "Actions" "Tags" "Square Bullets" on the menu bar. Doing so adds the following 
  425. text to your IPF file: 
  426.  
  427.       :lines.
  428.       &sqbul.
  429.       :elines.
  430.  
  431. From here it is then a simple matter to start creating lines that start with a 
  432. square bullet. Add the text for your line after the "&sqbul." formatting code. 
  433. If you need to add more than just one line you can highlight "&sqbul." and 
  434. click on "Edit" "Copy". Then you can add additional bullet formatting codes by 
  435. clicking on "Edit" "Paste". Just make sure to keep all your bulleted lines 
  436. between the :lines. and :elines. lines. 
  437.  
  438. You can combine bullets with links so that you can produce what you see in the 
  439. Introduction section of this help file. The IPF code looks like this: 
  440.  
  441.  
  442.    :p.
  443.    :lines.
  444.    &sqbul. :link reftype=hd res=10002.Getting Started:elink.
  445.    &sqbul. :link reftype=hd res=10003.Saving Your Work:elink.
  446.    &sqbul. :link reftype=hd res=10004.Creating a Header:elink.
  447.    &sqbul. :link reftype=hd res=10005.Creating Links:elink.
  448.    &sqbul. :link reftype=hd res=10006.Testing your work as you go.:elink.
  449.    &sqbul. :link reftype=hd res=10007.Editing Controls:elink.
  450.    &sqbul. :link reftype=hd res=10008.Using Bullets:elink.
  451.    :elines.
  452.  
  453.  
  454. Return to Introduction 
  455.  
  456.  
  457. ΓòÉΓòÉΓòÉ 9. Highlighting Text ΓòÉΓòÉΓòÉ
  458.  
  459. Once you've got most of your IPF file completed you can go back over it and 
  460. highlight selected text. This will allow you to have text that is in Bold, 
  461. Italic, Bold Italic, Blue or Red. 
  462.  
  463. Drag your mouse over the text you want highlighted. The marked text will appear 
  464. in white text on a black background. Click "Actions" "Tags" "Highlight Selected 
  465. Text...".  The following window will appear: 
  466.  
  467. Click on the kind of highlighting you want and that text will be tagged to 
  468. create that highlight when your IPF file is compiled. 
  469.  
  470. Return to Introduction 
  471.  
  472.  
  473. ΓòÉΓòÉΓòÉ 10. Fonts ΓòÉΓòÉΓòÉ
  474.  
  475. If you want to change fonts in your IPF file, bring up the pop-up menu and 
  476. click on "Tags" "Fonts...". This will bring up the following dialog box: 
  477.  
  478. Select the font you want and the point size of the font. To see samples of the 
  479. font you've selected you need to select the font, set the point size and select 
  480. the font again. Clicking on the button Set Font will insert the tag into your 
  481. IPF file. Clicking on the Cancel button will cancel any font changes. 
  482.  
  483. Note:   The new font you select will stay in effect until it is changed back to 
  484. the default font or another window is opened. Remember to change back to the 
  485. default font if you just want a block of text in another font. 
  486.  
  487. Return to Introduction 
  488.  
  489.  
  490. ΓòÉΓòÉΓòÉ 11. Bold Text ΓòÉΓòÉΓòÉ
  491.  
  492. This is just a little quicker way to get a selected block of text formatted as 
  493. Bold. The other alternative is using the Highlighting Text procedure. This will 
  494. give you more options as to how you want the selected text highlighted. 
  495.  
  496. Return to Introduction 
  497.  
  498.  
  499. ΓòÉΓòÉΓòÉ 12. Inserting a BMP ΓòÉΓòÉΓòÉ
  500.  
  501. Bitmaps can be inserted in your IPF file by clicking on "Actions" "Tags" 
  502. "Insert BMP...". This opens up a new window that allows you to select the BMP 
  503. file you want to include in your document. Click on "Select BMP" to make your 
  504. selection. The bitmap will be displayed in the window. If this is not the 
  505. bitmap you wish to insert, select another. When you are satisfied with your 
  506. selection click on "Insert BMP".  If you click on "Cancel", no bitmap will be 
  507. inserted into your IPF file. You will also get the option as to whether you 
  508. want the BMP aligned "Left", "Centered" or "Right". 
  509.  
  510. If you selected a file called "CDS.BMP" for example you would end up with 
  511. formatting similiar to: 
  512.  
  513.  :artwork align=Left name='E:\IPFBUILD\CDS.BMP'.
  514.  
  515. Because the program inserts the complete path to the BMP you selected, your BMP 
  516. file does not have to be located in the same directory as IPF Builder is 
  517. located. 
  518.  
  519. Return to Introduction 
  520.  
  521.  
  522. ΓòÉΓòÉΓòÉ 13. Changing Margins ΓòÉΓòÉΓòÉ
  523.  
  524. If you want to change the margins in your IPF file you can click on "Actions" 
  525. "Tags" "Margins" on the menu bar or right button click to bring up the popup 
  526. menu. 
  527.  
  528. The following window will open: 
  529.  
  530. Using the sliders you can set the Left and Right Margins. This will insert the 
  531. appropriate tags. 
  532.  
  533. Note:  You need to be careful that when you want the margins returned to their 
  534.        defaults that you once again set the margin tags. Opening the Margins 
  535.        window a second time and clicking the button will insert the margin tags 
  536.        to return to the default margins. 
  537.  
  538. Return to Introduction 
  539.  
  540.  
  541. ΓòÉΓòÉΓòÉ 14. Adding Text from another file ΓòÉΓòÉΓòÉ
  542.  
  543. If you have text in another file that you want to incorporate in your IPF file 
  544. you have two ways to accomplish this. 
  545.  
  546. Firstly, you can open the other text file with a text editor and then copy the 
  547. selected text from that file to the OS/2 Clipboard. Once in the Clipboard you 
  548. can "Paste" the text into your document. See Editing Controls 
  549.  
  550. Secondly, if you want to bring a complete file into your IPF document you can 
  551. "import" the file. Click on "File" on the menu bar then click on "Import 
  552. File...". A dialog box opens allowing you to select the file you wish to 
  553. import. 
  554.  
  555. With either method, the text you import will be inserted at the point that your 
  556. cursor is located in your IPF file when you invoked the procedure. 
  557.  
  558. Return to Introduction 
  559.  
  560.  
  561. ΓòÉΓòÉΓòÉ 15. Popup Menu for Quick Access ΓòÉΓòÉΓòÉ
  562.  
  563. For quick access to all the tags and for creating Links or New Headings you can 
  564. click the RIGHT BUTTON on your mouse. A popup menu is displayed. Select what 
  565. you want to do or what tag you want to insert in your IPF file. This saves you 
  566. having to move your mouse over to the menu bar. 
  567.  
  568. Return to Introduction 
  569.  
  570.  
  571. ΓòÉΓòÉΓòÉ 16. Creating Lists ΓòÉΓòÉΓòÉ
  572.  
  573. You can create different kinds of lists by clicking on "Actions" "Tags" "Lists" 
  574. or click the RIGHT MOUSE BUTTON to bring up the popup menu then clicking on 
  575. "Tags" and then "Lists". The following dialog box opens: 
  576.  
  577. Select the type of list you require and click "OK". You can cancel the process 
  578. by clicking the "Cancel" Button. 
  579.  
  580. Return to Introduction 
  581.  
  582.  
  583. ΓòÉΓòÉΓòÉ 17. Changing Colors ΓòÉΓòÉΓòÉ
  584.  
  585. If you want to change the color of a block of text, click on "Actions" "Tags" 
  586. "Colors". Select the Foreground and Background colors and click on "OK". When 
  587. you want to set the colors back to the default colors, click on "Colors" again 
  588. and then click "OK" without making any selections. You can also access the 
  589. colors dialog box by clicking your RIGHT MOUSE BUTTON, "Tags" and "Colors". 
  590.  
  591. The color dialog box looks like: 
  592.  
  593. Return to Introduction 
  594.  
  595.  
  596. ΓòÉΓòÉΓòÉ 18. Creating Footnotes ΓòÉΓòÉΓòÉ
  597.  
  598. Footnotes make it possible to double click on a word or phrase and get 
  599. additional information on that word or phrase from a window that opens up in 
  600. your INF or HLP file. 
  601.  
  602. To create a footnote, click on "Actions" "Create New Footnote" or select 
  603. "Create New Footnote" from the popup menu. When you click on "Footnotes" a 
  604. dialog box opens in which you can type in the reference id for the footnote you 
  605. are creating. 
  606.  
  607. Click the "OK" button to create the footnote or "Cancel" to abort the 
  608. procedure. 
  609.  
  610. The following will be entered into your IPF file: 
  611.  
  612. :fn id=ddrives.
  613. <place your text here>
  614. :efn.
  615.  
  616. Replace the "<place your text here>" with the text you want contained in the 
  617. footnote. 
  618.  
  619. Note:  You can place footnotes anywhere in your IPF file. It is probably a good 
  620.        idea to keep all your footnotes together so that you can easily find 
  621.        them should you wish to make any changes to their contents. 
  622.  
  623. See Creating Links for information on how to link selected text to a footnote 
  624. that you've created. 
  625.  
  626. Return to Introduction 
  627.  
  628.  
  629. ΓòÉΓòÉΓòÉ 19. Closing a File ΓòÉΓòÉΓòÉ
  630.  
  631. If you wish to open a different IPF file or start the creation of a new IPF 
  632. file you can close the file you are working on. Click on "File" "Close File " 
  633. from the menu bar. You will be given the option to save the IPF file. If you 
  634. cannot remember if you've saved the latest version it is a good idea to save it 
  635. now. 
  636.  
  637. When you've closed a file, your editing window will be blank and no file name 
  638. will be displayed in the "Editing IPF File:" field. From "File" on the menu bar 
  639. you will be able to create a new file, open an existing file or exit the 
  640. program. 
  641.  
  642. Return to Introduction 
  643.  
  644.  
  645. ΓòÉΓòÉΓòÉ 20. IPFC Context Sensitive Help ΓòÉΓòÉΓòÉ
  646.  
  647. Clicking on "Help" on the menu bar gives you the option to view the IPFC20.INF 
  648. file that provides online help for the IPFC compiler. 
  649.  
  650. If you require help on a specific IPFC tag you can drag your mouse over the key 
  651. word and highlight the word (or double click on the word) and then call up the 
  652. IPFC online help from the menu bar. This will take you directly to help on the 
  653. specific word you've selected. 
  654.  
  655. Note:  Sometimes the context sensitive search may not work if the text you 
  656. selected is not indexed in the IPFC20.INF file. You will be notified if a VIEW 
  657. was unsuccessful. If this happens you'll need to either change your selected 
  658. text and try again or bring up the general IPFC online help by not having any 
  659. text highlighted in your IPF file and search out the information from within 
  660. IPFC20.INF. 
  661.  
  662. Hint:  If you require help for a tag that is not included in IPF Builder, just 
  663. type in the tag and then highlight it. Click on "Help" "IPFC Help" to get 
  664. context sensitive help for that tag. 
  665.  
  666.  Return to Introduction 
  667.  
  668.  
  669. ΓòÉΓòÉΓòÉ 21. Create a Table ΓòÉΓòÉΓòÉ
  670.  
  671. With IPF Builder it is easy to create a table in your IPF document. Place your 
  672. cursor on a new line and click on "Actions" "Create a Table". 
  673.  
  674. Follow the procedure outlined below to create your table: 
  675.  
  676.  1. Enter the number of columns you want in your table. The maximum columns you 
  677.     can enter is 5. 
  678.  2. Enter the width of each column placing a space between each number you 
  679.     enter. Make sure to have a width entered for each column. If you are 
  680.     setting up a table with 3 columns for example and you wanted the first 
  681.     column to be 10 characters wide and the second column 20 characters wide 
  682.     and the third one 20 characters wide, you'd enter "10 20 20" (without the 
  683.     quotes). 
  684.  3. Next you select the kind of ruling lines you want in your table. You have a 
  685.     choice between BOTH, HORIZONTAL, VERTICAL or NONE. 
  686.  4. Next you select whether you want a BOX, RULES or NONE for a frame. 
  687.  5. After choosing the type of frame you want, you can start entering the text 
  688.     you want in each Row/Column in your table. Type the text into the entry 
  689.     fields to the right of "ROW 1" under each respective Column. When you have 
  690.     entered all the text for each column for ROW 1, click on the "INSERT" 
  691.     Button. (The TAB key will take you from entry field to entry field as you 
  692.     enter your text.) 
  693.  6. The contents of the entry fields will clear and you can enter your next Row 
  694.     which will now be named "ROW 2". Again, click the "INSERT" Button to insert 
  695.     the next Row of text. 
  696.  7. When you've finished entering text into your table, click on the "FINISHED" 
  697.     Button. The "Create a Table" window will close and you'll be returned to 
  698.     the IPF document with the table tags created. 
  699.  
  700. If you entered "Create a Table" by mistake, you can click on the "CANCEL" 
  701. Button to return to your document without creating a table. 
  702.  
  703. Note:  If you want to have a particular Row/Column blank with no text in it, 
  704. type a "." (period) in that entry field. Later you can delete this period 
  705. leaving only ":c." on that line if you don't want a period displayed in that 
  706. Row/Column of your table. 
  707.  
  708. Return to Introduction 
  709.  
  710.  
  711. ΓòÉΓòÉΓòÉ 22. User Installable Tags ΓòÉΓòÉΓòÉ
  712.  
  713. IPF Builder let's you create your own custom tags. You can create up to 10 tags 
  714. or macros. This makes IPF Builder even more powerful than before! 
  715.  
  716. Clicking on Macros on the menu bar will allow you to create up to 10 custom 
  717. pop-up menus. To create your first custom menu item, click on "Macros" "Edit 
  718. Custom 1". This will present you with the following window: 
  719.  
  720. Fill in the Menu Caption. This will be the menu item displayed in your pop-up 
  721. menu. Then fill in the Macro Text. Here you can place tags and text exactly as 
  722. you want it to appear when inserted in your IPF file. 
  723.  
  724. When you are finished, click on the "Save Macro" Button. If you do not wish to 
  725. save your new macro, click on the "Cancel" Button. 
  726.  
  727. Once you have created a new macro, you see it displayed when you click on 
  728. "Actions" "Custom Tags" or "Custom Tags" from the pop-up menu. Try out your new 
  729. macro. If it doesn't behave as you expected, go back to "Edit Custom 1" and 
  730. change the text in the "Macro Text" multiline entry box. 
  731.  
  732. Each custom macro that you create is stored in a file called CUSTOMn.MNU where 
  733. "n" refers to the number of your custom macro. 
  734.  
  735. You can create a macro file outside of IPF Builder by using a text editor and 
  736. creating a CUSTOMn.MNU file. The first line of the file contains the Menu 
  737. Caption and the remaining lines contain the Macro Text. The next time that you 
  738. load IPF Builder your pop-up menu will contain this new macro. 
  739.  
  740. Note:  If you want to delete a custom macro, you can simply delete the 
  741. appropriate CUSTOMn.MNU file. Do this when IPF Builder is NOT running. 
  742.  
  743.   Return to Introduction 
  744.  
  745.  
  746. ΓòÉΓòÉΓòÉ 23. Getting a Tree View of your IPF file. ΓòÉΓòÉΓòÉ
  747.  
  748. Clicking on "Tree View" on the menu bar will give you the following options: 
  749.  
  750. o View 
  751. o Build Tree View 
  752.  
  753.  Before you can "View" the Tree View of your IPF structure you must build a 
  754. tree view. The view you see is always the state of your IPF file since the last 
  755. time you built the tree view. In other words, if you've added or deleting a 
  756. heading since your last "Build Tree View", the changes will not be seen in the 
  757. tree view. 
  758.  
  759. Note:   If you create a new heading or delete a heading or make any changes to 
  760. a heading (such as renumbering it or moving it) you need to "Build Tree View". 
  761.  
  762. Double-clicking on one of the icons in the tree view will take you to that 
  763. heading in your IPF file. So you can also use this function to move quickly 
  764. around your IPF file. 
  765.  
  766. If you simply want to see the structure of your IPF file and not move to 
  767. another heading section, double click on the system menu icon on the top left 
  768. of the tree view window. 
  769.  
  770. Return to Introduction 
  771.  
  772.  
  773. ΓòÉΓòÉΓòÉ 24. System Requirements ΓòÉΓòÉΓòÉ
  774.  
  775. IPF Builder requires the following: 
  776.  
  777.                     Γûá OS/2 Version 2.0 or higher
  778.                     Γûá IPFC.EXE - Information Presentation Facility Compiler
  779.                     Γûá 8 MB of RAM or higher
  780.                     Γûá OS/2's REXX facility installed
  781.  
  782.   Return to Introduction 
  783.  
  784.  
  785. ΓòÉΓòÉΓòÉ 25. Technical Support ΓòÉΓòÉΓòÉ
  786.  
  787. Technical Support is available from Custom Design Software between the hours of 
  788. 9:00 am to 4:00 pm Pacific Standard Time. 
  789.  
  790. See "Help" - "About" for the phone number. You can also FAX any questions you 
  791. have to (604) 334-3125. 
  792.  
  793. Return to Introduction 
  794.  
  795.  
  796. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  797.  
  798. VX*REXX is copyrighted by WATCOM International Corporation.