home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 24 / CD_ASCQ_24_0995.iso / dos / tools / inter47 / int2whlp / i2w_cfg.txt < prev    next >
Text File  |  1995-05-29  |  16KB  |  356 lines
  1. ; The INT2WHLP configuration file has sections and entries similar to
  2. ; Windows INI files.
  3. ; Sections have identifiers enclosed in brackets [], starting at the left
  4. ; margin. A section extends up to the next line starting with a left
  5. ; bracket [ at the left margin.
  6. ; Entries have identifiers starting at the left margin and extending up
  7. ; to an equal sign =. The value of an entry is the string or integer after
  8. ; the equal sign. INT2WHLP interprets digit 0 as boolean value false and
  9. ; any non-zero integer as boolean true when interpreted with the
  10. ; profileBoolean() procedure.
  11. ; Section and entry identifiers are not case sensitive, however spaces
  12. ; are significant caracters in identifiers. There may not be excessive
  13. ; spaces around the equal sign in entries (i.e. only spaces which are part
  14. ; of the identifier or value).
  15. ; A semicolon ; at the left margin identifies a comment.
  16.  
  17. ; In the following text enabled identifiers specify default program
  18. ; settings (unless otherwise noted), and commented-out identifiers are
  19. ; examples of valid values.
  20.  
  21. ; The FILES section specifies the pathes for the input and output files.
  22. ; These values can also be specified as program parameters, program
  23. ; parameters take precedence over values defined in the configuration
  24. ; file. The program will request values if neither program parameters,
  25. ; nor the configuration file, define values.
  26. [FILES]
  27. inPath=
  28. ; inPath=c:\interrup
  29. ; The input files are in directory C:\INTERRUP.
  30. outPath=
  31. ; outPath=.
  32. ; Pass the output files to the current directory.
  33.  
  34. ; The OPTIONS section specifies values which can also be set by program
  35. ; parameter options. Program paramter options take precedence over values
  36. ; specified in the configuration file.
  37. [OPTIONS]
  38. build=
  39. ; build=(WINENV | APP1) & TESTBUILD
  40. ; Copies the build expression to the HPJ file's [OPTIONS] section build=
  41. ; entry. See also the [BUILDTAGS] section. Program option -b. Note that
  42. ; the OR operator "|" cannot be passed as a program option, only the
  43. ; configuration file can pass the OR operator to the program.
  44. compression=none
  45. ; compression=medium
  46. ; compression=high
  47. ; Sets HC31 compression option. Program option -c.
  48. filterFile=
  49. ; filterFile=INTWIN.FLT
  50. ; Should be empty for a compilation of the entier Interrupt List, or define
  51. ; a filter file for a partial compilation. Program option -f.
  52. ; NOTE! It is recommended not to perform a partial compilation because
  53. ; references to tables may be missing.
  54. singlesInMain=0
  55. ; singlesInMain=1
  56. ; If 1, interrupt numbers with only one entry are inserted directly in the
  57. ; compressed index rather than a reference to a one-entry subindex, provided
  58. ; that the number of compressed index columns is set to 1. singlesInMain=1
  59. ; may be an advantage for a strongly filtered list. Program option -1.
  60. twoIndexes=1
  61. ; twoIndexes=0
  62. ; Enables or disables the expanded index. Program option -2.
  63. errorLog=0
  64. ; errorLog=1
  65. ; Disables or enables HC31's log file OutPath\INTWIN.ERR. Program option -e.
  66. headers=1
  67. ; headers=0
  68. ; If 1, insert a header for each new interrupt number in the expanded index.
  69. ; Program option -h.
  70. indexColumns=1
  71. ; indexColumns=4
  72. ; indexColumns=8
  73. ; indexColumns=16
  74. ; Specifies the number of columns in the compressed index. Program option -i.
  75. markKeys=1
  76. ; markKeys=0
  77. ; Controls whether or not keywords (like "See also:", "Notes:") are marked
  78. ; (bolded). The program compiles the List 20% faster, and HC31 yields a 1%
  79. ; shorter .HLP file when disabled, but the readability of the result is lower.
  80. ; Program option -m.
  81. equalBlanks=1
  82. ; equalBlanks=0
  83. ; Specifies whether or not spaces are inserted around the equal sign in
  84. ; register search strings, e.g. "INT 21 AH = 4C" or "INT 21 AH=4C". Program
  85. ; option -q.
  86. releaseNo=41
  87. ; releaseNo=40
  88. ; Controls Interrupt List release number dependent behavior of INT2WHLP.
  89. ; Implemented influence:
  90. ;   releaseNo<41:  Tables are not treated as separate topics, no table cross
  91. ;           references.
  92. ; Program option -r
  93. scrollIndexTitle=1
  94. ; scrollIndexTitle=0
  95. ; Index windows have a general header and a title. If scrollIndexTitle=1,
  96. ; the title scrolls with the rest of the index window, otherwise the title
  97. ; is part of the non-scrolling header region. Program option -s.
  98. tableWindow=1
  99. ; tableWindow=0
  100. ; If 1, tables referenced from text (with a #nnnn hotspot) appear in
  101. ; a secodary window. The table can be copied to the main window with a
  102. ; "Copy to main" hotspot included in all tables.
  103. ; If 0, tables appear in the main window.
  104. ; Program option -t
  105. expandedIndex=1
  106. ; expandedIndex=0
  107. ; 1 or 0 causes the Interrupt List Index initially to pop up in expanded (all
  108. ; entries in one window) or in compressed (index with subindexes) format.
  109. ; Program option -x
  110.  
  111.  
  112. ; The CONFIG section defines WINHELP setups and defaults.
  113. [CONFIG]
  114. pos and size=
  115. ; pos and size=(0,0,980,1023)
  116. ; Defines the position and size of the initial main window. The format is
  117. ; (xpos,ypos,width,height) and valid values are 0..1023, defining 1024th
  118. ; of the screen witdh and hight. xpos+width and ypos+hight may not exceed
  119. ; 1023.
  120. secondary pos and size=(43,0,980,1023)
  121. ; secondary pos and size=(243,0,780,850)
  122. ; Defines the position and size of the secondary window. The format is the
  123. ; same as for "pos and size". The initial size of a secondary window MUST
  124. ; be defined. Users of large, high resolution screens may prefer the choice
  125. ; that is disabled above.
  126. ; The entry is ignored if secondary table windows are disabled.
  127. background=
  128. ; background=(255,255,255)
  129. ; Defines the background color of the normal text window in the format
  130. ; (red,green,blue). Valid values are 0..255. (255,255,255) defines a
  131. ; white background color.
  132. header background=
  133. ; header background=(255,255,192)
  134. ; Defines the background color of the non-scrolling part of the windows.
  135. ; (255,255,192) defines a light yellow color.
  136. text font=modern Courier New
  137. ; Defines the font used for the plain text. Due to the tables in the
  138. ; Interrupt List, this should be a fixed pitch font, and because it should
  139. ; be a TrueType font to take advantage of the font sizing, Windows 3.1
  140. ; has no alternatives. "modern" is the font family (modern=fixed pitch,
  141. ; roman=proportionally spaced serif, swiss=proportionally spaced sans serif),
  142. ; and "Courier New" is the font name.
  143. ; If point size 10 or 12 (see deciPoints) is used, the bitmapped font
  144. ; "modern Courier" can be used, though.
  145. header font=roman Times New Roman
  146. ; header font=swiss Arial
  147. ; Font used for headers.
  148. deciPoints=90
  149. ; deciPoints=95
  150. ; deciPoints=100
  151. ; deciPoints=120
  152. ; 10 times the font point size. A 9 point font can be displayed on a
  153. ; standard VGA screen without the need of horizontal scroll. The point
  154. ; size is not true typographical point size, it varies with screen
  155. ; resolution and size, and a larger point size is preferable for a high
  156. ; resolution screen with small dimensions. HC31 assigns size in half-points,
  157. ; corresponding to deciPoints increments of 5.
  158. header deciPoints=140
  159. header 2nd deciPoints=120
  160. ; Two font sizes used in the headers.
  161.  
  162. ; The INTWINCONFIG section is optional and is not used for program generated
  163. ; output. Entries in the section are copied to the help project file's
  164. ; [CONFIG] section. It can be used to insert macros in the final help file.
  165. ;[INTWINCONFIG]
  166. ;InsertItem("mnu_help","mnu_h","&INTWIN Help","JI(`',`idHelp')",0)
  167.  
  168. ; The WINDOWS section defines the number of extra "windows" included in
  169. ; the compilation in addition to the Interrupt List.
  170. [WINDOWS]
  171. number=4
  172. ; Number of additional windows (5 are defined, but only 4 enabled).
  173. ; NB! number=0 is the program default, and the following windows are not
  174. ; defined by default.
  175.  
  176. ; For each window defined by the [WINDOWS] number=n entry, there must be
  177. ; a section [WINDOW 1], ... [WINDOW 9], [WINDOW 10], ... [WINDOW n] with
  178. ; 3 obligatory entries and some optional entries.
  179. [WINDOW 1]
  180. title=Ports
  181. id=idPorts
  182. ; title and id are obligatory entries defining the topic title and
  183. ; identifier (context string). [WINDOW i] sections with an empty title=
  184. ; or id= entry are ignored, and a warning is printed on the screen.
  185. ; See comment "Help windows topic titles and identifiers" in INT2WHLP.INC
  186. ; for reserved identifiers.
  187. type=2
  188. ; There are 3 window types: type=1 are single entry windows referenced
  189. ; directly from the main index. type=1 is the default type. type=2 are
  190. ; windows with their own index, which is referenced from the main index.
  191. ; The differences between type=1 and type=2 are the browse chain linkage
  192. ; and the default "file n type=" value. type=3 defines a window with at
  193. ; least one RTF file defining the window properties. The RTF file must
  194. ; have a topic with the identifier (context string) defined by id=, and
  195. ; that topic should have a title defined by title= and contain an index
  196. ; for the system.
  197. ; files=1
  198. ; The entry files= defines the number of files included in the current
  199. ; window. Only type=3 windows can have more than one file, and files=1 is
  200. ; the default value.
  201. file 1=ports.lst
  202. ; For each file i = 1..n defined by the files=n entry (normally only 1)
  203. ; there must be a file i=<file name> entry specifying a file. See a later
  204. ; paragraph about default directories.
  205. ;
  206. ; file 1 type=2
  207. ; There are 4 file types: file i type=1 are files passed to the program's
  208. ; ProcessFile() procedure. file i type=2 are files passed to the program's
  209. ; ProcessPort() procedure. file i type=3 are RTF files defining their own
  210. ; and other included files' properties. file i type=4 are files assigned
  211. ; their own titles and identifiers (context strings). type=4 files are
  212. ; passed to the program's ProcessFile() procedure, and they should be
  213. ; referenced from an RTF file.
  214. ; The default file i type= value is the window's type= value.
  215. ; Files' default directories depend on the file types. File types 1 and 2
  216. ; are typically files included in the Interrupt List: PORTS.LST, MEMORY.LST
  217. ; etc. Therefore, the default directory for file types 1 and 2 is the
  218. ; InPath directory. File type 3 are typically the user's own file or one
  219. ; of the RTF files supplied in this package, so the default directory
  220. ; is 1) the current directory or 2) INT2WHLP's home directory. File type
  221. ; 4 are the users own files, and the default directory is the current
  222. ; directory.
  223. ; In all cases the full path (a path including a drive, the root, or the
  224. ; current or parent directory . or ..) can be specified to override the
  225. ; default directory.
  226. ;
  227. ; file i title=<title>
  228. ; file i id=<id>
  229. ; file i chain=<browse chain>
  230. ; Type 4 files have titles, identifiers, and browse chain definitions.
  231. ; The default values are "<window title> - i", "<window id>_i", and
  232. ; "<window id>:5" where i is the current file number. The empty value is
  233. ; legal for file i chain= and causes the file to be excluded from any
  234. ; browse chain.
  235. ; See comment "Help windows topic titles and identifiers" in INT2WHLP.INC
  236. ; for implemented browse chains.
  237.  
  238. [WINDOW 2]
  239. title=Memory
  240. id=idMemory
  241. ; type=1 is the default window type
  242. ; files=1 is the default number of files
  243. file 1=memory.lst
  244. ; file 1 type=1 is the default type because the window type is 1.
  245.  
  246. [WINDOW 3]
  247. title=CPU
  248. id=idCPU
  249. file 1=86bugs.lst
  250.  
  251. [WINDOW 4]
  252. title=CMOS
  253. id=idCMOS
  254. file 1=cmos.lst
  255.  
  256. ;[WINDOW 5]
  257. ;   (This part is disabled due to aliases required by the assosiated file)
  258. ;title=Miscellaneous Information
  259. ;id=MISC_INF_0
  260. ;type=3
  261. ; type=3 specifies a window with its own definition in an RTF file.
  262. ; MISC_INF_0 is the identifier (context string) for one of the topics in
  263. ; the RTF file. That topic is normally an index for other topics in the
  264. ; file.
  265. ;
  266. ; files=1 is the default number of files
  267. ;file 1=misc_inf.rtf
  268. ;   (misc_inf.rtf references context strings that should be defined in the
  269. ;    ALIAS part of the configuration file)
  270. ; file 1 type=3 is the default type because the window type is 3. It
  271. ; specifies an RTF file.
  272.  
  273. ; The ALIAS section is optional and is not used for program generated
  274. ; output. It compiles an ALIAS list to the HPJ file. Two of the RTF files
  275. ; supplied in this pasckage (SEL_TOPC.RTF and MISC_INF.RTF) require
  276. ; some aliases.
  277. ; [ALIAS]
  278. ; id87err=INT 10 ---- - CPU-generated (80286+) - COPROCESSOR ERROR
  279. ; idVideo_00=INT 10 00-- - VIDEO - SET VIDEO MODE
  280. ; idVideo_1013=INT 10 1013 - VIDEO - SELECT VIDEO DAC COLOR PAGE (VGA)
  281. ; Each entry is of the form
  282. ;   id=<modified INT header>
  283. ; where id is a user defined identifier (context string) no longer than 18
  284. ; characters, and <modified INT header> is an INT header with flags removed
  285. ; from char. pos. 9+ (i.e. if char. 9 is not "-" then delete up to, but not
  286. ; including, a "-" character), and with a register value (from the divider
  287. ; line char. pos. 13-16) + a space inserted at char. pos. 8-12, as shown in
  288. ; the example. The program substitutes the actual identifier (context string)
  289. ; for the <modified INT header> and copies the id=actual_id part to an
  290. ; [ALIAS] section in the HPJ file. The example would result in an HPJ
  291. ; section (based on Interrupt List release 40):
  292. ;
  293. ; [ALIAS]
  294. ; id87err=10_1
  295. ; idVideo_00=10_2
  296. ; idVideo_1013=10_46
  297. ;
  298. ; The entries must appear in the same order as the <modified INT header>
  299. ; appear in the Interrupt List. The program can assign more than one user
  300. ; defined id to the same interrupt entry in the list, the entries must of
  301. ; course be consecutive and have identical <modified INT header> values.
  302. ;
  303. ; Empty lines and lines starting with a semicolon (;) are ignored.
  304.  
  305. ; Also the TABLEALIAS section is optional and compiles an ALIAS list to the
  306. ; HPJ file. SEL_TOPC.RTF require some tabel aliases.
  307. ; [TABLEALIAS]
  308. ; idListList=21 52-- Format of List of Lists:
  309. ; Each entry is of the form
  310. ;   id=II FUNC <title>
  311. ; where id is a user defined identifier (context string) no longer than 18
  312. ; characters, II is a two digit hexadecimal number and FUNC is four characters
  313. ; describing the subfunction where the table is located. II and FUNC are also
  314. ; characters 11-12 and 13-16 of the previous divider line. <title> is the
  315. ; table's title. The program substitutes the actual identifier (context
  316. ; string) for the II FUNC <title> part and copies the id=actual_id part to
  317. ; an [ALIAS] section in the HPJ file, mixed with the output from an [AIAS]
  318. ; section in the configuration file. The example would insert in an HPJ
  319. ; [ALIAS] section an entry like (depending on Interrupt List release):
  320. ;
  321. ; idListList=t0724
  322. ;
  323. ; The entries must appear in the same order as the tables appear in the
  324. ; Interrupt List. The program can assign more than one user defined id to
  325. ; the same table.
  326. ;
  327. ; Empty lines and lines starting with a semicolon (;) are ignored.
  328.  
  329. ; The INTWINCONFIG section is optional and is not used for program generated
  330. ; output. It is included to facilitate copying macros to the [CONFIG]
  331. ; section in the Help Project File.
  332. ; [INTWINCONFIG]
  333. ; InsertItem("mnu_help","mnu_hlp","&INTWIN Help","JI(`',`idHelp')",0)
  334.  
  335. ; The BUILDTAGS section is optional and is not used for program generated
  336. ; output. It is included to support users' RTF files with conditional
  337. ; build. If the user's RTF files have build tags ("*" footnotes), the tags
  338. ; must be defined in a BUILDTAGS section in the configuration file.
  339. ; [BUILDTAGS]
  340. ; WINENV
  341. ; APP1
  342. ; TESTBUILD
  343. ;
  344. ; The BUILGTAGS section is simply copied to the HPJ file, ignoring empty
  345. ; lines and lines starting with a semicolon (;).
  346. ;
  347. ; See also the [OPTIONS] section's build= entry.
  348.  
  349. ; The BAGGAGE section is optional and is not used for program generated
  350. ; output. It is included to support inclusion of baggage in the help file.
  351. ; [BAGGAGE]
  352. ; BAG.INI
  353. ;
  354. ; The BAGGAGE section is simply copied to the HPJ file, ignoring empty
  355. ; lines and lines starting with a semicolon (;).
  356.