home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / htmipf13.zip / README.TXT < prev   
Text File  |  1999-05-06  |  3KB  |  90 lines
  1. HTMIPF.
  2.  
  3. DATE   : 6-may-1999
  4. VERSION: 1.3.
  5.  
  6. HTMIPF is a freeware html to ipf compiler for OS/2.
  7. The program is written by: J. de Keijzer.
  8. For suggestions or questions email: 101322.3665@compuserve.com.
  9.  
  10. The program may be distributed, but only when this readme is included!
  11.  
  12. Improvements:
  13. - Multiple heading levels supported in the map file.
  14. - Filename read from the html doc are normalized which prevents multiple loads
  15. of the same file.  c:\test\contents.htm is the same as contents.htm when c:\test 
  16. is the working directory.
  17. - Duplication of res numbers solved.
  18.  
  19. Command line.
  20.  
  21. htmipf  {<infile> | /MAP:<mapfile> } { /OUT:<outfile> }
  22.  
  23. infile : the file to be compiled.
  24. example:
  25. HTMIPF hello.html. The compiler will parse the hello.htm file and all the files
  26. which are referenced in this file and create hello.ipf.
  27. All GIF,TIF,PCX,Win BMP images are automatically
  28. converted to OS/2 bitmap files and put in the current working directory, with
  29. the same name as the image found in the HTML file. UNI0X1.GIF will be translated
  30. to UNI0X1.BMP. The initial file <infile> gets an ipf panel with the name "doc" all
  31. referenced files get a panel name with the reference name. The compiler can create
  32. named panels, see the /MAP: option. The compiler will not generate an index. The final
  33. ipf file must be compiled with the IPFC compiler to get the final document. The IPF
  34. source can be used for .HLP and .INF files.
  35.  
  36. /MAP:<mapfile>
  37. When this option is used the /OUT:<outfile> becomes mandatory.
  38. This option is used to compile unrelated html file into one ipf file.
  39.  
  40. Map file format:
  41. #uuapex20  hello.htm   [<level>]
  42. level     : 'h' | 'H' <number>
  43. number    :  1...9. (1 is default)
  44. The hash<name> is the helptopic.
  45.  
  46. example of a map file:
  47. #MyPanelName   hello.htm   h2
  48. #ThisPanel     manual.htm
  49.  
  50. The compiler starts with reading the hello.htm and gives it the panel
  51. name "MyPanelName". When the file manual.htm is not already compiled and
  52. thus not referenced in hello.htm, the compiler will compile manual.htm and
  53. give it the panel name "ThisPanel". The panel names can be used in 3GL and
  54. 4GL programs to access the online help.
  55. The hello.htm gets a heading level of 2.
  56.  
  57. /OUT:<outfile>
  58. With this option the filename of the compiled source can be defined. When
  59. not defined, the compiler will create an IPF file with the same name as
  60. the HTML file. This option is mandatory when the /MAP: option is used.
  61.  
  62.  
  63. Syntax checking:
  64. Most HTML files are not strict. Open tags are sometimes not closed or
  65. implicitly closed with non related tags. The compiler will give a
  66. warning on this and fix it for ipf. Although the compiler can fix a
  67. lot, it is recommended to create strict HTML files to avoid unpredicted
  68. compiler output.
  69.  
  70.  
  71. Some restrictions and limitations:
  72.  
  73. <TABLES> - IPF tables cannot contain images. When the HTML table
  74. contains two columns the compiler transtales the table into a
  75. definition list which is less strict as the IPF table. Hence,
  76. HTML tables with two columns may contain images and other mark up
  77. tags. The maximum column with in the compiled source is 40 characters.
  78.  
  79. <FONT> - Only the courier font can be set. Other fontnames are ignored.
  80.  
  81.  
  82. Known problems:
  83. Compiling large documents can sometime result in duplicate panel id's.
  84. This problem was found when the HTML reference manual was compiled.
  85.  
  86. Jasper de Keijzer.
  87. 101322.3665@compuserve.com.
  88. Also writer of DrawIt for OS/2. (See BMT-MICRO).
  89.  
  90.