home *** CD-ROM | disk | FTP | other *** search
/ Power CD-ROM!! 7 / POWERCD7.ISO / prgmming / inter43 / int2whlp / i2w-hint.txt < prev    next >
Text File  |  1994-11-04  |  8KB  |  190 lines
  1. This is a sort of a guide to using the INT2WHLP precompiler. INT2WHLP
  2. transfers Ralf Brown's Interrupt List to some RTF (Rich-Text Format) files
  3. which can be used as input for Microsoft's HC31 WINHELP file compiler.
  4.  
  5. This text gives also some hints on using the the results of the compilation.
  6.  
  7.  
  8. COMPILATION
  9.  
  10. The easy way to compile the list is this:
  11.  
  12. Change to the directory where you want your INTWIN.HLP file. There should
  13. be at least 16 Mb free space on the disk. It can be the directory with the
  14. Interrupt List files (which we will call the Source Directory), but it is
  15. better to use a separate directory not to mess up the Source Directory. A
  16. subdirectory under the Source Directory would be fine. Copy the following
  17. files to the directory:
  18.     INTWIN.BAT
  19.     INT2WHLP.EXE
  20.     INT2WHLP.CFG
  21.     SEL_TOPC.RTF
  22.     MISC_INF.RTF
  23.     INTWIN.PH
  24. It is handy also to have:
  25.     I2W-FILE.TXT
  26.     I2W-HINT.TXT (this file)
  27.     I2W-CFG.TXT
  28.     I2W-OPT.TXT
  29. in the directory. For a partial compilation of the List, FLT_METH.RTF is
  30. required (see paragraph FLT_METH.RTF in I2W-FILE.TXT).
  31.  
  32. Make sure that the following files are in the Source Directory:
  33.     INTERRUP.LST or INTERRUP.A, INTERRUP.B, ...
  34.     INTERRUP.1ST
  35.     CATEGORY.KEY
  36.     OVERVIEW.LST
  37.     INTERRUP.PRI
  38.     PORTS.LST
  39.     MEMORY.LST
  40.     CMOS.LST
  41.     GLOSSARY.LST
  42. where INTERRUP.LST is the concatenation of INTERRUP.A, INTERRUP.B, ... .
  43.  
  44. Make sure that HC31.EXE is somewhere on the DOS path.
  45.  
  46. Type
  47.     INTWIN
  48. at the DOS prompt to start the compilation. On a 486/33MHz computer it
  49. takes INT2WHLP 1 1/2 minut to precompile release 41 of the List, and it
  50. takes HC31 40 minutes to create the INTWIN.HLP file.
  51.  
  52.  
  53. CONFIGURATION
  54.  
  55. The INT2WHLP program lets you personalize your INTWIN.HLP file. If you use
  56. high resolution graphics on a large screen, then read the comments in the
  57. [CONFIG] section of the INT2WHLP.CFG file. For more details, see the files
  58. I2W-CFG.TXT and I2W-OPT.TXT.
  59.  
  60.  
  61. COMPRESSION
  62.  
  63. The HC31 program supports three levels of compression: high, medium, and
  64. none. Medium compressed and uncompressed files are about 15% and 100%
  65. longer than highly compressed files, respectively. HC31 can use an existing
  66. file with compression information (a PH file), and it needs not to be
  67. exactly up-to-date. Compiling release 41 with a PH file from release 40
  68. gives a file about 4% longer than a compilation with an up-to-date PH file.
  69.  
  70. Compiling the compression information file is very resource consuming. For
  71. Interrupt List release 41 compiled with INT2WHLP v. 1.10:
  72.     631 kb < required DOS RAM < 730 kB
  73.     27 Mb < required free disk space < 50 Mb
  74. The compilation of the compression info took 20 minutes, and the rest of
  75. the compilation took 40 minutes on a 486/33MHx computer. Actually, when
  76. the computer gave up due to insufficient RAM when 631 kb were available,
  77. it had already created an INTWIN.PH file that was identical to the final
  78. file.
  79.  
  80. We will try in the future to include an INTWIN.PH file based on a beta
  81. release of the list, and we will try to update that file to include the
  82. correct release date. You should control that INTWIN.PH includes a line
  83. identical to line 1 in INTERRUP.A, except that 6 spaces have been
  84. substituted for 2 or 3 tabs. The date at the end of the line appears
  85. also as a separate entry in the INTWIN.PH file. Edit INTWIN.PH if
  86. appropriate. This is essential because the string appears in about 260
  87. locations in the help file.
  88.  
  89.  
  90. HIGH RESOLUTION GRAPHICS
  91.  
  92. The default settings allow you to display the List on a normal 640x480 VGA
  93. screen without the need of horizontal scroll. If you use high resolution
  94. graphics on a large screen, you will want to define another size of the
  95. secondary window used to display the tables, see comments in the [CONFIG]
  96. section in file INT2WHLP.CFG.
  97.  
  98. If you use a high resolution graphics on a screen with small dimensions, you
  99. might want to use a larger font. The file package I2W-TEST.ZIP contains files
  100. that let you experiment with different fonts with very short INT2WHLP and
  101. HC31 compilation times. Unzip the package to a subdirectory under your
  102. INT2WHLP directory and read its README file.
  103.  
  104.  
  105. LIMITATIONS
  106.  
  107. DOS graphics characters (ACSII codes > 126) are not necessarily converted to
  108. correct Windows equivalents.
  109.  
  110. INT2WHLP cannot handle more than 63 graphics characters per line. It does,
  111. though, convert the horizontal single and double framing characters to '-'
  112. and '=' if a primary attempt to complile the line fails, so it is unlikely
  113. that the program will error-exit due to this limitation.
  114.  
  115.  
  116. INTWIN's TOPIC SEARCH FACILITIES
  117.  
  118. INTWIN facilitates seaching interrupt topics with many different keys, based
  119. on:
  120.     a. Elements in the interrupt header line.
  121.     b. Keys in the file CATEGORY.KEY for the appropriate interrupt
  122.        category.
  123.     c. Combinations of interrupt number and register contents.
  124.     d. Category letters.
  125.  
  126. For example,
  127.  
  128. --------O-214302-----------------------------
  129. INT 21 - DR-DOS 3.41+ internal - GET ACCESS RIGHTS
  130.     AX = 4302h
  131.  
  132. will be listed with the following search keys:
  133.     DR-DOS 3.41+ internal           \    a
  134.     GET ACCESS RIGHTS               /
  135.     other operating systems         \ 
  136.     non-standard operating systems   >   b
  137.     operating systems (non-standard)/
  138.     INT 21 AX = 4302                \
  139.     INT 21 AH = 43                   \
  140.     INT 21          *)                \
  141.     21 4302                            \ c
  142.     21 43                              /
  143.     21              *)                /
  144.     AX = 4302                        /
  145.     AH = 43                         /
  146.     O!              **)                  d
  147. *)  WINHELP lists only the first 400 search hits.
  148. **) Because WINHELP's search facility does not distinguish between letter
  149.     case, the search keys for capital letter categories are the letter
  150.     followed by an exclamation mark.
  151.  
  152.  
  153. TABLE CROSS-REFERENCES
  154.  
  155. Tables are separate topics in help files compiled with version 1.08+ of
  156. INT2WHLP. When referenced from a "#nnnn" hotspot, the table pops up in a
  157. secondary window, thus the user can easily change between the source in
  158. the main help window and the referenced table in the secondary window.
  159. However, secondary windows are less flexible than the main window: topics
  160. are not recorded in the history list, you cannot browse between topics (<<
  161. and >> pushbuttons), and the topics cannot be copied or printed from the
  162. secondary window. Therefore all tables have a "Copy to Main" hotspot at the
  163. top.
  164.  
  165. The table topic titles include the interrupt number and subfunction where
  166. the table is defined, and there is a hotspot at the end of each table that
  167. pops up the appropriate interrupt in the main window.
  168.  
  169. There are two search keys for each table topic: "#nnnn" where nnnn is the
  170. four digit table number, and the table title as given in the Interrupt List
  171. ("Bitfields for ...", "Call ... with:", "Format of ...", "Values for ...").
  172.  
  173.  
  174. HELP WINDOW PUSHBUTTONS
  175.  
  176. The Help Window includes some extra shortcut pushbuttons.
  177.  
  178. "Print" sends the current topic to the currently selected printer. To select
  179. another printer, use "Print Select..." from the "File" menu.
  180.  
  181. "Copy" copies the current topic to the Cllipboard. To copy only part of the
  182. topic, use "Copy..." from the "Edit" menu.
  183.  
  184. "Exit" closes both the main window and an open secodary (table) window.
  185. Selecting "Close" from the control menu or pressing Alt F4 closes only the
  186. main window.
  187.  
  188. "Print" and "Exit" are equivalent to selecting "Print Topic" and "Exit" from
  189. the "File" menu.
  190.