home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / ipfrev.zip / REVIEW.Z / SAMPLE.INF (.txt) < prev    next >
OS/2 Help File  |  1995-01-03  |  55KB  |  343 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. IPF Review Overview ΓòÉΓòÉΓòÉ
  3.  
  4. IPF Review allows you to comment on IPF helps and books without printing them 
  5. first.  Reviews are done on line. 
  6.  
  7. The author as well as the reviewer will want to have a copy of IPF Review for 
  8. thorough and ongoing communications.
  9.  
  10. The author prepares the IPF document by pointing to IPF Review and compiling 
  11. with IPFC or exporting in Hyperwise.  (Whether authoring of the IPF file was 
  12. done with Hyperwise or an ASCII editor and IPFC, the compiled results are the 
  13. same and both can be used with IPF Review.) 
  14.  
  15. The reviewer opens the prepared document and, panel by panel, comments with IPF Review.
  16.  
  17. Once review comments are complete and saved, IPF Review prints the current, 
  18. open  comment file or, like  a report, combines any number of comment files and 
  19. prints.  In a single report, an author can see commentors' names and dates, 
  20. along with all comments on each and every panel. 
  21.  
  22. To respond, the author can use IPF Review to edit the same comment file.
  23.  
  24.     Go on to "Getting Started".
  25.  
  26.  
  27. ΓòÉΓòÉΓòÉ 2. Getting Started  ΓòÉΓòÉΓòÉ
  28.  
  29. Before reviewing an IPF file, you must "prepare" it, by adding two statements. 
  30.  
  31. Preparing a document for IPF Review with Hyperwise:
  32.  
  33. Open your .WF document.
  34.  
  35. Click on Document.
  36.  
  37. Click on Properties...
  38.  
  39. In the DLL name field, type COMMENT.
  40.  
  41. In the Object name field, type INITCOMMENT.
  42.  
  43. Add a document title if it's not already there.
  44.  
  45. Save the document.
  46.  
  47. Click on Document.
  48.  
  49. Click on Export and INF.
  50.  
  51. Click on INF. (Even if it is going to finally be a help file, for review 
  52. purposes, you need to compile it as a "book" file.)
  53.  
  54. Export and copy into the review directory.
  55.  
  56. Preparing a document for IPF Review with IPFC: 
  57.  
  58. Open your IPF source (tagged) document.
  59.  
  60. Add the following statement after docprof=
  61.  
  62. Save the document.
  63.  
  64. Compile to INF. (Even if it is going to be a help or HLP file when complete, 
  65. for review purposes, you'll need to compile it as a "book" or INF file.) 
  66.  
  67. Copy your "prepared" INF file to the directory that contains the IPF Review 
  68. program.  If you used the default, it is in C:\REVIEW
  69.  
  70.    Go on to "Learning IPF Review".
  71.  
  72.  
  73. ΓòÉΓòÉΓòÉ 3. Learning IPF Review ΓòÉΓòÉΓòÉ
  74.  
  75. Install IPF Review by placing the diskette in drive A:.  Open an OS/2 window 
  76. and type: 
  77.  
  78. A:Install
  79.  
  80. Follow the screen directions.
  81.  
  82. We have provided SAMPLE.INF and SAMPLE.REV files for you to learn to use IPF 
  83. Review. 
  84.  
  85. 1.  Open an OS/2 command prompt window, change to the directory you installed 
  86. IPF Review (C:\REVIEW\ if you took the default) and type 
  87.  
  88. VIEW SAMPLE.INF
  89.  
  90. The INF table of contents and a comment file dialog appear. 
  91.  
  92. 2.  Fill in the name of a new comment file or select one that already exists. 
  93. For this exercise, open SAMPLE.REV.
  94.  
  95. Another table of contents window appears at the top right of the screen.  The 
  96. table of contents on the right  mirrors that of the active INF file on the left 
  97. except that it has all of the "hidden" panel titles displayed in gray so you 
  98. can comment on those too.  SAMPLE.INF has no hidden panels.
  99.  
  100. If you selected SAMPLE.REV, one panel already has review comments and has an 
  101. icon in front of the panel title to show that it has been reviewed. 
  102.  
  103. When you start any new comment file, it's important to complete the Reviewer 
  104. Information. 
  105.  
  106. 3.  Click on File and Reviewer Information. 
  107.  
  108. 4.  Fill out the Reviewer data and click on the OK button.
  109.  
  110. 5.  Doubleclick on a panel title from either the right or left table of 
  111. contents window.  The panel opens and its contents display in the top left 
  112. window while a clean comment window appears on the bottom.
  113.  
  114. 6.  With the focus on that bottom window, type your comments. 
  115.  
  116. 7. Open another panel and note that another icon appears.  If you cut or delete 
  117. all comments on a single panel, the icon disappears.
  118.  
  119. 8.  If you want to copy lines from your INF file to the comment window, 
  120. doubleclick with mouse button 2 on the line to be copied.  It appears 
  121. automatically in the comment window with quotes around it. 
  122.  
  123. You can copy an entire panel of text into the IPF Review comment window by 
  124. clicking on Services and Copy in the INF file window (upper left).  Graphics 
  125. and other objects cannot be copied.  Only text will import.
  126.  
  127. 9.  Save your comment file and print . 
  128.  
  129. To print a combination of files, you need to open an OS/2 window, move to your 
  130. review directory and type Report.
  131.  
  132.  
  133. ΓòÉΓòÉΓòÉ 4. Open Comment File ΓòÉΓòÉΓòÉ
  134.  
  135. Make your selection from this window or type a new filename from this window 
  136. with an .REV extension.  Files with a .REV extension are automatically displayed.
  137.  
  138. Open filename 
  139.  
  140. Type the name of an existing or new file.
  141.  
  142. Type of files 
  143.  
  144. Display <All Files>.
  145.  
  146. Drive 
  147.  
  148. Select the drive your .REV files are kept.
  149.  
  150. File 
  151.  
  152. Highlight the filename to open.
  153.  
  154. Directory 
  155.  
  156. Select the directory.
  157.  
  158.  
  159. ΓòÉΓòÉΓòÉ 5. File ΓòÉΓòÉΓòÉ
  160.  
  161. File contains the following options:
  162.  
  163. Open page 
  164.  
  165. Click on this to open the panel that is currently highlighted.
  166.  
  167. Another way to open a panel is to doubleclick on the panel title. 
  168.  
  169. Save 
  170.  
  171. Click on Save to save your comment file. 
  172.  
  173. Save as... 
  174.  
  175. Click on Save as... and a dialog appears requesting the name of the file.  Type 
  176. an eight character or less name and REV as the extension.
  177.  
  178. Reviewer Information 
  179.  
  180. Click on this option to add or update information about yourself as the 
  181. reviewer or to look up information about the person who  reviewed your document.
  182.  
  183. Print 
  184.  
  185. Click on this to see the print dialog.
  186.  
  187.  
  188. ΓòÉΓòÉΓòÉ 5.1. Open Panel ΓòÉΓòÉΓòÉ
  189.  
  190. Open page 
  191.  
  192. Click on this to open the panel that is currently highlighted.
  193.  
  194. Another way to open a panel is to doubleclick on the panel title. 
  195.  
  196.  
  197. ΓòÉΓòÉΓòÉ 5.2. Save ΓòÉΓòÉΓòÉ
  198.  
  199. Save 
  200.  
  201. Click on this option to save your comment file.  The comment file is saved 
  202. automatically when you ask to have a print while it is open.
  203.  
  204.  
  205. ΓòÉΓòÉΓòÉ 5.3. Save As ΓòÉΓòÉΓòÉ
  206.  
  207. Save as... 
  208.  
  209. Click on Save as... and a dialog appears requesting the name of the file.  Type 
  210. an eight character or less name and REV as the extension.
  211.  
  212.  
  213. ΓòÉΓòÉΓòÉ 5.3.1. Save as... Dialog ΓòÉΓòÉΓòÉ
  214.  
  215. To have two copies of your file, you can save one with a different name.
  216.  
  217. Save as file name 
  218.  
  219. Type an eight character or less file name and REV as the extension.
  220.  
  221. Save file as type 
  222.  
  223. Leave the selection <All Files>.
  224.  
  225. Drive 
  226.  
  227. Highlight the appropriate drive letter.  This is the drive your new file will 
  228. be saved.
  229.  
  230. File 
  231.  
  232. For saving (not selecting) the file names are grayed.
  233.  
  234. Directory 
  235.  
  236. Select the directory you want to save your REV file. 
  237.  
  238.  
  239. ΓòÉΓòÉΓòÉ 5.4. Reviewer Information ΓòÉΓòÉΓòÉ
  240.  
  241. Reviewer Information keeps track of the comment file and the person reviewing. 
  242. The author wants to know who reviewed , when and then how to contact that person.
  243.  
  244. Click on this option to bring up the Reviewer Information Dialog.
  245.  
  246.  
  247. ΓòÉΓòÉΓòÉ 5.4.1. Reviewer Information Dialog ΓòÉΓòÉΓòÉ
  248.  
  249. Reviewer information contains important contact information such as name, Id 
  250. and phone number.
  251.  
  252. Comments file name 
  253.  
  254. The filename created or selected and its location is displayed.  The computer 
  255. date of the comment file is also displayed. 
  256.  
  257. Review file 
  258.  
  259. All of the information available about the INF document is placed here.
  260.  
  261. Reviewer name 
  262.  
  263. Type your own name into this field.  This field has a 40 character limit.
  264.  
  265. Phone 
  266.  
  267. Type the phone number you can be reached during business hours. This field has 
  268. a 40 character limit. 
  269.  
  270. FAX 
  271.  
  272. Type the FAX number you can be reached during business hours.  This field has a 
  273. 40 character limit.
  274.  
  275. Network Id 
  276.  
  277. Identify your Id and the network you access for business use.  This field has a 
  278. 40 character limit.
  279.  
  280. General Comment 
  281.  
  282. In the general comment window, type any general comments you have about the 
  283. book or helps you are reviewing.  General comments are included in the printed report.
  284.  
  285.  
  286. ΓòÉΓòÉΓòÉ 5.5. Printing  ΓòÉΓòÉΓòÉ
  287.  
  288. With IPF Review, you can save to file or print individual comment files. 
  289. Choose this option to print only the current comment file.
  290.  
  291. You can also save or print a combined list of all of the comments on each 
  292. panel. 
  293.  
  294. To print a single or combined report, you will use another program named 
  295. Report.  It was shipped and installed with your IPF Review program. 
  296.  
  297. From a command window, change to the directory you installed IPF Review and 
  298. type Report. 
  299.  
  300. A dialog appears.  Give the report a name, check the print checkbox if you want 
  301. to print your report and click on the Find.... button.  Another dialog appears, 
  302. named the Select Comments Files Dialog.  Click with mousebutton 1 on the 
  303. filename(s).  Click on the OK button and the  report generator dialog reappears 
  304. with the selected filename(s) listed.  If that list is the one you really want 
  305. to save to file and/or print, click on the Report button.
  306.  
  307.  
  308. ΓòÉΓòÉΓòÉ 5.6. Exit ΓòÉΓòÉΓòÉ
  309.  
  310. File Exit allows you to close IPF Review.  Be sure to save your work before you exit.
  311.  
  312.  
  313. ΓòÉΓòÉΓòÉ 6. Help ΓòÉΓòÉΓòÉ
  314.  
  315. Under Help, you can access the index and general help.  General help gives you 
  316. an overview of IPF Review and leads you to other panels with Getting Started 
  317. and Using information. 
  318.  
  319.  
  320. ΓòÉΓòÉΓòÉ 7. Help Index ΓòÉΓòÉΓòÉ
  321.  
  322. Click on Help index to see the index associated with IPF Review's online information.
  323.  
  324.  
  325. ΓòÉΓòÉΓòÉ 8. Edit ΓòÉΓòÉΓòÉ
  326.  
  327. Edit's Copy, Cut and Paste help you delete, move and copy.
  328.  
  329. Copy 
  330.  
  331. Copies the marked text (leaving the original intact) and saves it to the OS/2 
  332. system clipboard.
  333.  
  334. Cut 
  335.  
  336. Cuts the marked text (deletes it from the marked area) and saves it to the OS/2 
  337. system clipboard.
  338.  
  339. Paste 
  340.  
  341. Places information you have copied or cut.
  342.  
  343.