5.6. INI formats

This is a variable=value section sorted by variable name (using memcmp), except for Custom tab, which occurs at the end.

Table 5.48. Explanations for all the different [OPTIONS] that are displayed and preserved by HHW.

Variable & typeExplanationRecommended settingDefault 
Auto Index=bool  No 
Auto TOC=numberWARNING: HHW modifies your HHC file if you specify this. IMO this is a bug: HHW should just slurp through a pipe or temporary file. No 
Binary Index=bool YesYes 
Binary TOC=bool YesNo 
CITATION=string    
COMPRESS=number    
COPYRIGHT=string    
Compatibility=1.0|1.1 or laterAnything other than 1.0 is treated as 1.1 or later1.1 or later1.1 or later 
Compiled file=path  hhp stem.chm 
Contents file=pathThe name HHW gives to new files is Table of Contents.hhc   
Create CHI file=bool  No 
DBCS=boolIf you find any thing about this please tell us.No 
Default Font=string,number,number    
Default Window=stringThere is no default, but when you add a window definition HHW will change this.   
Default topic=pathIf there are any files in the [FILES] section then the default for this option will be the first one.   
Display compile notes=bool    
Display compile progress=bool    
Enhanced decompilation=bool  No 
Error log file=path    
Flat=bool NoNo 
Full text search stop list file=path    
Full-text search=bool YesNo 
IGNORE=string    
Index file=pathThe name HHW gives to new files is Index.hhk   
Language=hex numberstring  OS ?thread?user?system? LCID. 
PREFIX=string    
Sample Staging Path=pathThis must be samples or any upper-case variation of it or this feature will NOT work.   
Sample list file=path    
TMPDIR=string    
Title=string    
Custom tab="string",stringCan put multiple lines of this option to define more than one custom tab.   
???=???The following were strings in hha.dll & were accepted by HHW, but it didn't display or preserve them: Word Breaker, PredefinedSubsets, EnableStructuralSubsetting, FTS for untitled topics, Information Types=path, Index separators, DAT FILE, URL ROOT, REPLACE, VERSION, WARNING, ROOT, BUILD, BMROOT. If you find out their meaning or find any more please tell us about them.  

This is a variable=value section sorted by order of addition.

Each line has the following format:

string =" string ", " path ", " path ", " path ", " path ", " path ", " string ", " path ", " string ", number , number , [ number , number , number , number ], number , number , number , number , number , number , number

Table 5.49. Summary of the arguments for each [WINDOWS] entry.

Argument numberExplanation
0The window type.
1The title bar text.
2The TOC file.
3The Index file.
4The Default file.
5The file shown when the Home button is pressed.
6The file shown when the Jump 1 button is pressed.
7The text of the Jump 1 button.
8The file shown when the Jump 2 button is pressed.
9The text of the Jump 2 button.
10A bit feild of navigation pane styles.
11Width of the navigation pane in pixels.
12A bit field of the buttons to show.
13Initial position of the window on the screen: [left, top, right, bottom].
14Style Flags. As set in the Win32 SetWindowLong & CreateWindow APIs.
15Extended Style Flags. As set in the Win32 SetWindowLong & CreateWindowEx APIs.
16Window show state. As set in the Win32 ShowWindow API. SW_HIDE works well - don't use it. The following are buggy in HH 1.31: SW_SHOWMINIMIZED, SW_MINIMIZE, SW_SHOWMINNOACTIVE - grey toolbars, no nav pane or HTML display when unminimized; SW_MAXIMIZE - maximizes the navigation pane, if present; SW_FORCEMINIMIZE - works same as SW_HIDE, when should just minimize.
17Whether or not the navigation pane is initially closed. 1 = closed, 0 = open
18The default navigation pane. 0 = TOC, 1 = Index, 2 = Search, 3 = Favorites, 4 = History (not implemented by HH), 5 = Author, 11-19 = Custom panes.
19Where the navigation pane tabs should be. 0 = Top, 1 = Left, 2 = Bottom & anything else makes the tabs appear to be behind the pane on Win95.
20ID to send in WM_NOTIFY messages.
??HHW currently accepts only 21 arguments. If you find any more please tell us about them.

Table 5.51. Navigation pane styles.

ValueExplanationRecommended setting
0x00000001Automatically hide/show tri-pane window: when the help window has focus the navigation pane is visible, otherwise it is hidden.Off
0x00000002Keep the help window on top.Off
0x00000004No title barOff
0x00000008No default window styles (only HH_WINTYPE.dwStyles)Either
0x00000010No default extended window styles (only HH_WINTYPE.dwExStyles)Either
0x00000020Use a tri-pane windowOn
0x00000040No text on toolbar buttonsOn
0x00000080Post WM_QUIT message when window closesOff
0x00000100When the current topic changes automatically sync contents and index.On
0x00000200Send tracking notification messagesOff
0x00000400Include search tab in navigation paneOn
0x00000800Include history tab in navigation paneOff
0x00001000Include favorites tab in navigation paneOn
0x00002000Put current HTML title in title barOn
0x00004000Only display the navigation windowOff
0x00008000Don't display a toolbarOff
0x00010000MSDN MenuOff
0x00020000Advanced FTS UI.On
0x00040000After initial creation, user controls window size/positionOn
0x00080000Use custom tab #1Off
0x00100000Use custom tab #2Off
0x00200000Use custom tab #3Off
0x00400000Use custom tab #4Off
0x00800000Use custom tab #5Off
0x01000000Use custom tab #6Off
0x02000000Use custom tab #7Off
0x04000000Use custom tab #8Off
0x08000000Use custom tab #9Off
0x10000000The window type has a marginOn
0x?0000000The rest of the navigation pane styles either do nothing or are unknown. If you find out what others do please tell us.

This is a list of CHMs to merge this one with. See the Merge Files feature in the features list for more information. Help 2 only used Collections to merge CHMs. HHA Version 4.74.8702 will crash if there are more than 1148 entries in the merge files list (could be a mem thing, but probably not). Note that the internal file formats only allow storage of 1004 entries in the internal binary merge files list. Any lines that begin with a comment character (;), after any whitespace, are ignored. Any whitespace at the end or start of a filename is stripped away.