home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / i2htm091.zip / readme.txt < prev   
Text File  |  1998-11-11  |  6KB  |  161 lines
  1.  
  2.  
  3. INF2HTML V0.91 (w) (c) 1998 Ulrich Möller
  4.  
  5.  
  6. INTRODUCTION
  7. ============
  8.  
  9. INF2HTML is a small utility which will take any INF or HLP file as an
  10. input and produce a set of HTML files, each containing one page
  11. ("panel") of the input file.
  12.  
  13. INF2HTML automatically creates links between the files so that you
  14. can view the HTML ouput with any browser in a way similar to
  15. VIEW.EXE.
  16.  
  17. INF2HTML's HTML output will contain a few extra tag attributes which
  18. are not part of standard HTML. Browsers will ignore this, but the
  19. most valuable HTML2IPF utility by Andrew Pawel Zabolotny will be able
  20. to produce IPF source files accordingly. I will publish an updated
  21. version soon which can handle more extra tags, so perfect translation
  22. between the two formats will be possible.
  23.  
  24.  
  25. USAGE
  26. =====
  27.  
  28. Per default, INF2HTML will create a subdirectory in the directory of
  29. the input file where it will store the HTML ouput files. This
  30. directory will have the same name as the filestem of the input file
  31. (e.g. "CMDREF" if you decode "CMDREF.INF").
  32.  
  33. Each HTML file will be given a file name according to the following:
  34.  
  35.     <idx>_L<level>_<title>.html
  36.  
  37. with:
  38.     <idx> being the table-of-contents index of the file, so that each
  39.           file will be given a unique number;
  40.     <level> being the table-of-contents level of the file (1 for root
  41.             level entries); a "H" letter will be appended if that
  42.             panel is hidden in the table of contents;
  43.     <title> being the first 20-or-so characters of the panel's title,
  44.             as it would be shown in VIEW.EXE.
  45.  
  46. In addition, INF2HTML will create one HTML file with the same filestem
  47. as the input file which will contain the main index (as displayed in
  48. the "Contents" tree of VIEW.EXE).
  49.  
  50. Note that this implies that INF2HTML will only work on HPFS drives.
  51. There is no error checking for this, so be careful.
  52.  
  53. INF2HTML will overwrite any files in the output directory without
  54. warning.
  55.  
  56.  
  57. OPTIONS
  58. =======
  59.  
  60. For a description of further options at the command line, simply type
  61. "INF2HTML", and it will briefly explain itself.
  62.  
  63. You can, for example, specify a different output directory.
  64.  
  65. In addition, by using the "-F" flag, INF2HTML can operate in "frames"
  66. mode also, which will create an additional "index.html" file in the
  67. output directory with a frameset for both the contents tree
  68. (<filestem>.html) on the left and the panels on the right. In
  69. "frames" mode, all the links in the HTML output will have proper
  70. "TARGET" parameters in the <A> tags.
  71.  
  72. INF2HTML can also produce additional titles at the top and "Next"/
  73. "Back" links at the bottom of each page by using the "-n" or "-N"
  74. flags.
  75.  
  76. If you specify "-b", INF2HTML will output uncompressed OS/2 V1.3
  77. bitmaps too. These can be handled by HTML2IPF to produce IPF source
  78. files accordingly.
  79.  
  80. If you wish to view images using a normal browser, you'll have to
  81. convert them to GIF. There is a small REXX script ("BMP2GIF.CMD")
  82. which will do this job for you, provided that you have the
  83. "Generalized Bitmap Module" (GBM) on your PATH, which is available as
  84. Freeware with source code at Hobbes. INF2HTML has already inserted
  85. proper <IMG> tags into the HTML output, which will point to GIF files
  86. with the same filestem.
  87.  
  88.  
  89. REVISION HISTORY
  90. ================
  91.  
  92.     V0.91 (Nov. 10, 1998)
  93.     ---------------------
  94.         --  Added bitmap decoding.
  95.         --  Added additional tags for window positioning, which
  96.             are not part of default HTML and should thus not
  97.             hurt.
  98.  
  99.     V0.90 (Nov. 10, 1998)
  100.     ---------------------
  101.         Initial release.
  102.  
  103.  
  104. KNOWN LIMITATIONS
  105. =================
  106.  
  107. --  There are problems with codepages. INF2HTML simply writes out
  108.     the text as it comes in the INF file, so certain special
  109.     characters might turn out to be displayed wrong.
  110.  
  111.     This applies especially to INF tables. These are implemented
  112.     using pre-formatted text with ASCII graphics characters, which
  113.     browsers do not display correctly.
  114.  
  115. --  Even though window positioning is now implemented, there are
  116.     still problems with the Toolkit docs. Since HTML does not
  117.     support this, you'll get many empty pages for API descriptions,
  118.     because these are implemented using auto-links. Specify "-a"
  119.     at the command line to have "real" links created. I'll think
  120.     of some compatible way to have this work.
  121.  
  122.  
  123. LICENSE, COPYRIGHT, DISCLAIMER
  124. ==============================
  125.  
  126.     Copyright (C) 1998 Ulrich Möller.
  127.  
  128.     This program is free software; you can redistribute it and/or modify
  129.     it under the terms of the GNU General Public License as contained in
  130.     the file COPYING in this directory.
  131.  
  132.     This program is distributed in the hope that it will be useful,
  133.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  134.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  135.  
  136.     For details, refer to the "COPYING" file.
  137.  
  138.  
  139. CREDITS
  140. =======
  141.  
  142.     Thanks go out to Peter Childs, Australia, for writing that
  143.     "Inside INF" article in EDM/2, vol. 3 no. 8, which has the most
  144.     valuable information about the INF format.
  145.  
  146.     I have included "inf03.txt" from that article in the source
  147.     directory.
  148.  
  149.     The bitmap decompression code (new with V0.91) at the bottom was
  150.     written by Peter Fitzsimmons (pfitz@ican.net), who kindly sent me
  151.     his code upon my cry for help in WarpCast. Thanks a lot.
  152.  
  153.  
  154. CONTACT, SUGGESTIONS
  155. ====================
  156.  
  157. Ulrich Möller
  158. e-mail:     ulrich.moeller@rz.hu-berlin.de
  159. www:        http://www2.rz-hu-berlin.de/~h0444vnd/os2.htm
  160.  
  161.