Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

8 Generating WinHelp > 8.13 Configuring contents for WinHelp > 8.13.1 Naming and configuring Help files and titles


8.13.1 Naming and configuring Help files and titles

Mif2Go creates a WinHelp contents file for you, unless you specify no contents. Whether the contents file is created from a single topic file or from multiple files, and how the contents file and Help file are named, depend on the following settings:

[HelpContents]

; the optional .cnt file for HelpVer 4 is always named after the rtf

; CntType = None, Full (single file), or Body (headings, topics only)

; the Body type is used when combining .cnt files in a .bat file

CntType=Full

; CntBase = helpfile.hlp (default is rtfname.hlp; specify for Body)

CntBase=myfile.hlp

; CntName = helpfile.cnt (default is rtfname.cnt; specify for Body)

CntName=myfile.cnt

; CntStartFile = helpfile.bct (default is to use CntBase and CntTitle)

CntStartFile=myfile.bct

; CntTitle = Title for Contents (for Full .cnt)

;CntTitle=Project Name

; CntTopic = starting topic for .hpj (default: book or chapter name)

;CntTopic=myfile

; CntTopHead = 1 Text for Optional Top Head (Full .cnt, for a H1)

;CntTopHead=1 Book Title

If you have only one topic file in your Help project, in the [HelpContents] section leave the default value, CntType=Full; Mif2Go creates the .cnt file for you.

If you have more than one topic file in your Help project, set CntType=Body; Mif2Go creates part of the .cnt file for each topic file, and also produces a file named after your topic file, with extension .bct, which contains only the header and topic lines. If you specify CntType=Body, you can also specify the name of the contents file and the base name of the help file. If you do not specify a base name, Mif2Go uses your topic file name for the help file base name.

Alternatively, for multiple topic files you can set the first topic file to CntType=Full, so it contains the Base, Title, and Top Head (if any). Or you can just prepare the first bit of the final .cnt separately, in a text editor.

Use CntTitle to specify the text of the title for the contents file; to specify a starting topic, set CntTopic. If you do not specify a value for CntTitle, Mif2Go uses the help file title (in the .hpj file). The value you specify (if any) for CntTopHead is added before the actual .cnt entry lines.

You can also create a .cnt heading for a topic file even though that heading is not in the topic file itself:

[HelpContents]

CntType=Body

[BctFileHeads]

myfile=Text for optional top head



8 Generating WinHelp > 8.13 Configuring contents for WinHelp > 8.13.1 Naming and configuring Help files and titles