home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / ipf10b.zip / read.me next >
Text File  |  1994-07-04  |  4KB  |  103 lines
  1. READ.ME - May 27, 1994
  2.  
  3. Rtf2Ipf v1.0b
  4.  
  5. Author:  Mark Ault
  6. CIS ID:  74101,413
  7.  
  8.  
  9.  
  10. Rtf2Ipf is a program to convert a word processing document saved in Rich
  11. Text Format into a file suitable for compiling into on-line help with 
  12. the IPFC compiler.  By creating you documentation in your favorite word
  13. processor you have access to all of its editing tools such as spell 
  14. checker, thesaurus, grammar checkers, etc.  You may also find you can 
  15. keep both on-line and printed documentation in sync from the same source
  16. document.
  17.  
  18. This package is free for anyone to use or distribute in its entirety.
  19. I am not responsible for any problems that this program may cause.
  20.  
  21. I do ask that if you find this program useful then please send me a note.
  22. This is only so that I may get an idea if anyone is using the program and
  23. if further enhancements would be worth my time.
  24.  
  25.  
  26.  
  27. Files
  28. -----
  29.  
  30. read.me      -  this file
  31. rtf2ipf.exe  -  the executable program
  32. rtf2ipf.sam  -  soft copy of the documentation in AmiPro v2.0 format
  33. rtf2ipf.ipj  -  the 'IPF project file' used to create the file rtf2ipf.ipf
  34. rtf2ipf.rtf  -  the documentation saved as Rich Text Format (RTF)
  35. rtf2ipf.ipf  -  the documentation ready to be compiled by IPFC to create an
  36.                 on-line OS/2 book
  37. rtf2ipf.sty  -  the style sheet used to create the documentation.
  38.  
  39.  
  40. Current version of RTF2IPF can always be found in the following CIS forums:
  41.     IBM OS/2 Developer 1 Forum (OS2DF1) section - Development Tools
  42.     IBM Systems Forum (IBMSYS) section - OS/2 Utilities
  43.  
  44.  
  45. Installation
  46. ------------
  47.  
  48. You should have received the Rtf2Ipf utility as a single self extracting ZIP
  49. file named IPF10B.EXE.  To install the utility create a directory to hold the
  50. utility and run the IPF10B.EXE program from a DOS window or full screen.  No 
  51. parameters are needed.
  52.  
  53. Once you have the files decompressed you may want to compile the manual with 
  54. IPFC.  To compile the manual into an .INF file use the following command from 
  55. an OS/2 window or full screen:
  56.  
  57.     IPFC RTF2IPF.IPF /INF
  58.  
  59. Once the on-line book has been created you may view it using the following 
  60. command from an OS/2 window or full screen:
  61.  
  62.     START VIEW RTF2IPF.INF
  63.  
  64. If you find yourself using the on-line book often you may want to create a 
  65. program object on you desktop or a folder for convience.  You may also want
  66. to print the documentation.  You can either print the documentation from
  67. within the on-line viewer or for better results you may want to try to import
  68. the original AmiPro document into your favorite word processor.  If that is
  69. not successful try importing the .RTF version of the document as most word
  70. processors have a pretty good filter for .RTF files.
  71.  
  72.  
  73. Change History
  74. --------------
  75.  
  76. 07/04/94 - Released version 1.0b.
  77.  
  78.            Fixed an assertion error caused when the RTF file did not
  79.            explicitly define a '\s1' style.  The first style is style
  80.            number one implicitly.
  81.  
  82.            Added some up front editing of the .IPJ file.  In particular
  83.            a title is required as well as a Heading1Level.
  84.  
  85.            Added memory auditing routines.  All 'malloc' / 'free' pairs
  86.            have been replace with debugging wrappers.  Only one malloc /
  87.            free pair remains because when I replace it memory gets too
  88.            fragmented and I start having problems allocating memory.
  89.  
  90.            Cleaned up the horrible long series of if statements used to
  91.            translate special characters to the IPF output equivalents.
  92.            This logic is now nicely table driving as it shoulg have been
  93.            in the first place.
  94.  
  95. 06/05/94 - Released version 1.0a.  
  96.  
  97.            Fixed a bug that would cause an infinite loop whenever your 
  98.            document had more than one header or footer definition in the
  99.            RTF file.  Also added support for heading levels 4-9.
  100.  
  101. 05/18/94 - Released version 1.0
  102.  
  103.