home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 24 / CD_ASCQ_24_0995.iso / dos / tools / inter47 / int2guid / int2guid.doc < prev    next >
Text File  |  1994-11-02  |  6KB  |  113 lines
  1. The program INT2GUID converts the Interrupt list files into an input file
  2. for the TurboPower Software MAKEHELP program to create a GUIDE or POPHELP
  3. Popup Reference Machine database. The program is a transcription of INT2QH
  4. written by Kai Uwe Rommel.
  5.  
  6. GUIDE is included in some versions of the Turbo Professional package, and
  7. POPHELP is included in the Object Professional package from TurboPower
  8. Software. MAKEHELP is included in both packages and compiles help files
  9. for its accompanying popup program.
  10.  
  11. INT2GUID reads either the interrup.lst file or the partial interrup.a ...
  12. files, and other files defined in the INT2GUID and in the configuration file
  13. INT2GUID.CFG. The files must be located in the current directory. The
  14. created MakeHelp source file is written to standard output and can be
  15. redirected. Two temporary files topic.tmp and subtopic.tmp are created in
  16. the current directory during the process.
  17.  
  18. The configuration file allows conditional compilation, and it is configured
  19. for a compilation that is acceptable by both versions of MAKEHELP. It can
  20. be edited for compilations optimized for GUIDE or POPHELP, see comments in
  21. INT2GUID.CFG.
  22.  
  23. From the 2/91 list, INT2GUID creates a 1.6M source file for MAKEHELP which
  24. then creates a help database of about 1.3M (poor compression ratio!).
  25. INT2GUID executes i 1'15" on a 20 MHz 386 based machine, and MAKEHELP
  26. executes in 2'40".
  27.  
  28. The 2/91 Interrupt list, and other files used for this help system,
  29. includes about 2500 topics. The topics are in general listed in 18 lines
  30. sub and sub-sub indices, and the sub indices are again listed in the main
  31. index. GUIDE and POPHELP can also pop up on a topic indicated by an
  32. interrupt number at the cursor's position on the screen.
  33.  
  34. GUIDE is capable of handling about 4300 topics, and POPHELP can handle
  35. about 5000.
  36.  
  37. Bent Lynggaard.
  38.  
  39.  
  40. 1992-04-16. INT2GUID generates a 2.3 MB file with 3505 topics from the
  41. INTER29x files (February 1992), and the database file is 1.8 MB long.
  42.  
  43.  
  44. 1992-12-19. The configuration file that is included with INT2GUID v. 1.07
  45. is optimized for POPHELP. The main reason is that the Interrrupt List has
  46. grown to exceed the capacity of the GUIDE program. INT2GUID can create one
  47. or two help files for the GUIDE program from selected parts of the Interrupt
  48. List. The configuration file should be edited for GUIDE optimization, see
  49. comments in the file. If two help files are created, the initial part of
  50. INTERRUP.A should be the initial part of both source files. GUIDE should
  51. be initialized with the file requesting more resources, so sufficient memory
  52. will be allocated to serve any of them, thus the proper file can be activated
  53. by F3 when GUIDE is active.
  54.  
  55. The average topic length has been reduced since the first versions of
  56. INT2GUID to appr. 7.6 characters, allowing about 8600 topics in the POPHELP
  57. system. Facilities are included in INT2GUID v. 1.07 to include Function
  58. Classification characters as parts of the topic names. Function Classification
  59. will be introduced in the Interrupt List after release 33. This will increase
  60. the average length by two characters, thus reducing the maximum number of
  61. topics to about 6800. The facility can be enabled and disabled in the
  62. configuration file INT2GUID.CFG.
  63.  
  64. INT2GUID generates a 3.1 MB file with 4842 topics from the Interrupt List
  65. files release 32 (September 1992), and the database file is 2.6 MB long.
  66.  
  67. 1993-04-12: Minor editings in INT2GUID.C, POPHINTS.TXT, and INT2GUID.HLP.
  68. Classification enabled in INT2GUID.CFG. INT2GUID.TBL updated to Interrupt
  69. List release 34.
  70.  
  71. INT2GUID generates a 3.4 MB file with 5193 topics from the Interrupt List
  72. files release 34 (April 1993), it uses 350 kB disk space for temporary files
  73. in the current directory, and the database file created by MAKEHELP is 2.8 MB
  74. long.
  75.  
  76. 1993-07-03: Fixed a bug in INT2GUID. The bug was introduced i version 1.07
  77. and caused an infinite loop if the input source was a single INTERRUP.LST
  78. file.
  79.  
  80. Ralf Brown's INTPRINT program provides an exelent filter that can reduce
  81. the size of the database file for POPHELP/GUIDE. New options in INTPRINT
  82. will keep the original divider lines (-k) and avoid paging (-l0), so the
  83. result can be used as input for INT2GUID. Use
  84.     INTPRINT -k -l0 -L1 -FINT2GUID.FLT [-sSUMMARY] -m INTERRUP.A INTERRUP.LST
  85. where INT2GUID.FLT is a file with filter information. The optional SUMMARY
  86. file eases the adjustment of the filter. An INT2GUID.FLT file is included
  87. in this package which filters out about 3/4 of the Interrupt List. See also
  88. INTPRINT.DOC for filter file formats. Notice that a filtered version of the
  89. Interrupt List cannot legally be publicly distributed due to copyright
  90. restrictions.
  91.  
  92. 1994-03-19: INT2GUID version 1.10 must have a parameter "-nofilter" or
  93. "-f<file name>" to specify in the copyright notice if the transcription is
  94. based on a filtered version of the Interrupt list. <file name> is the name
  95. of an INTPRINT filter file used to create a partial Interrupt List. If
  96. -f<file name> is specified, INT2GUID will include topic "Filter File" with
  97. the contents of file INT2GUID.RE2 followed by the contents of the specified
  98. file. INT2GUID will toggle MAKEHELP text attribute 1 before and after the
  99. included filter file. The default MAKEHELP attribute 1 (and the alternative
  100. attribute suggested in file POPHINTS.TXT section 4) uses an alternate
  101. background color, so trailing blanks appear in the output.
  102.  
  103. It is legal to redistrubute also partial transcriptions of Ralf Brown's
  104. Interrupt List provided that it is stated in the copyright notice. INT2GUID
  105. does its best to include the proper information, notice however that the
  106. user of INT2GUID is responsible for correct copyright notices in
  107. redistributed transcriptions.
  108.  
  109. 1994-11-02: The Interrupt List has grown so big that POPHELP can no longer
  110. handle the whole list. Thus it is necessary to pass the list through a filter
  111. before compiling it. Remember to specify the filter file name to INT2GUID
  112. also with the -f<file name> option.
  113.