5.7. Sitemap (HTML) formats

The order of global properties is as follows: [FrameName] [WindowName] [Information Types] [ImageList] [Image Width] [Color Mask] [Background] [Foreground] [ExWindow Styles] [Window Styles] [ImageType] [Font]

Table 5.52. Global HHC properties.

PropertyExample valueExplanation
FrameNameleftThis is used where the topics should open in a specific HTML frame.
WindowNamemainThis is used where the topics should open in a specific window.
ImageListfoobar.bmpPath of a BMP that stores multiple images of the same size in a horizontal array.
Image Width16The width of the images in the ImageList file. HHW is buggy with respect to this; it ignores what is in the file, only ever displays 20 in the GUI and preserves the value in the file.
Color Mask0xFFOnly output by FAR. Has an effect on Foreground & Background colours. Unknown.
Background0xffffffColour of the background of the TOC window. White default. In hex format.
Foreground0x0Colour of the text of the TOC window (window & page names). Black default. In hex format.
ExWindow Styles0x6300Win32 extended window style DWORD. In hex format.
Window Styles0xc01627Win32 window style DWORD. In hex format.
ImageTypeFolderWhen using standard images (ImageList is not present), causes different icons to be used. Normally headings use a book icon & pages have a page icon with a question mark on it. If this property is "Folder" then headings will use a Folder icon and pages will have a page icon with horizontal lines on it.
FontTimes New Roman,8,0Font name, font size, character set.
Auto GeneratedYesOutput when the HHC has been automatically generated by HHW during the compilation process when Auto TOC is present in the HHP.

The information types are also stored in the global properties and their order is as follows: ((SaveType|SaveHidden|SaveExclusive) SaveTypeDesc)... [(Category CategoryDesc ((Type|TypeHidden|TypeExclusive) TypeDesc)...)...]

The order of the item properties is as follows: Merge | ([Name] ([Type...] [Local] [URL])... [FrameName] [WindowName] [Comment] [New] [ImageNumber])

Table 5.54. Properties for HHC items.

PropertyExample valueExplanation
Name What is displayed in the Contents.
Local The
URL  
ImageNumber The image to display for this item.
New When an auto image is being used this increases the image number by 1 so that this image [] is seemingly added to the image.
Comment  
FrameName  
WindowName  
Type  
Merge  

The order of global properties is as follows: [FrameName] [WindowName] [Font]

Table 5.55. Global properties of the HHK format.

PropertyExample valueExplanation
FrameNameleftThis is used where the topics should open in a specific HTML frame.
WindowNamemainThis is used where the topics should open in a specific window.
FontTimes New Roman,8,0Font name, font size, character set.

The information types are also stored in the global properties and occur before the properties above, but they are not preserved by HHW. Their order is as follows: ((SaveType|SaveHidden|SaveExclusive) SaveTypeDesc)... [(Category CategoryDesc ((Type|TypeHidden|TypeExclusive) TypeDesc)...)...]

Table 5.56. Information types of the HHK format.

PropertyExample valueExplanation
SaveTypeManagerDeclares an information type as Inclusive.
SaveHiddenCode monkeyDeclares an information type as Hidden.
SaveExclusiveEngineerDeclares an information type as Exclusive.
SaveTypeDescA professional of the engineering discipline.Describes the previously declared information type.
CategoryExperience levelDeclares a category.
CategoryDescHow knowledgeable you are.Describes the previously declared category.
TypeLuserDenotes an information type that belongs to the previously declared category as an Inclusive type.
TypeHiddenHackerDenotes an information type that belongs to the previously declared category as a Hidden type.
TypeExclusiveGuruDenotes an information type that belongs to the previously declared category as an Exclusive type.
TypeDescOne who knows everything.Describes the previously denoted information type.

The order of the item properties is as follows: Merge | ([Name] ([Name] [Type...] [Local [URL] | See Also])... [FrameName] [WindowName] [Comment])

Table 5.57. Item properties of the HHK format.

PropertyExample valueExplanation
NameITSF formatThe first instance is the keyword string to be displayed in the index.
TypeExperience Level::LuserCategory::Type
Localitsf.htmlThe file to load when the user selects the index item.
URL Should not be present unless Local also is. In the HHW GUI it is an "Alternate URL". Not sure what it does though.
See AlsoITSF internal file formatsWhen the user double-clicks the index item the Index control will jump to the Index entry whose keyword is the value of this param. Mutually exclusive with the Local [URL] pair.
FrameNameleftThe frame to open the topic in.
WindowNamemainThe window to open the topic in.
Comment Dunno what this does.
Merge