You are here: Working with Projects > Help Target Properties > WinHelp 4.0

WinHelp 4.0

This target produces the standard 32-bit Windows Help 4.0.

Build

AttributeExpression

Specifies an advanced conditional build expression for a help target.

GenerateProjectFile

When set to False, the existing .hpj or .hhp files will not be overwritten when building the Help target.

OwnTOC

Determines whether TOC customization performed on the Contents tab applies only to the current help target or to other targets as well.

Display Properties

ButtonLabel

Specifies the text that precedes the subtopic buttons.

ButtonLabelStyle

Lists the name of the style used to format the label that precedes the subtopic buttons.

ButtonSeparator

When enabled, a dividing line separates the topic text from the subtopic buttons.

ButtonStyle

Lists the name of the style used to format automatically generated subtopic buttons.

ColorReduction

Determines the color threshold for images that are saved with source documents. This property has no effect on linked images that are not saved with the document.

 

Value

Description

 

None

Images are not converted.

 

16 Colors

Images with more than 16 colors are reduced to 16.

 

256 Colors

Images with more than 256 colors are reduced to 256.

ScaleGraphics

When set to False, graphics contained with the source documents will not be scaled.

ShowDropdownText

If set to True, drop-down text is shown in the help target, otherwise they are removed.

ShowExpandText

If set to True, drop-down text is shown in the help target, otherwise they are removed.

Localization Properties

CodePage

Defines the windows codepage number to be used by the Help file. This property is most commonly used when producing Help files in foreign languages, providing special character sets for translation on the screen or in print.

Locale

This property is used to specify the language in the resulting target files. Each target has its own way of specifying language. For example, HTML Help has a Language option in the [OPTIONS] section of the project file (.hhp).

Miscellaneous Properties

BaseName

Base file name to be used for generating WinHelp target files. By default, this name will be the same as the file name for the Help project itself.

Citation

Appends a citation to the end of any information (except in a context-sensitive pop-up window) that is copied from the Help file.

Compression

Determines the level of file compression used by the WinHelp compiler.

 

Value

Description

 

None

No compression.

 

Chose best

The WinHelp compiler determines the best algorithm to use.

 

Phrase

For Help files under 100K.

 

Hall

For Help files that will be compressed again by another utility.

 

Zeck

Minimal compression for quick builds.

 

Zeck + Phrase

Minimal compression for Help files under 100K.

 

Zeck + Hall

Maximum compression.

CopyFolder

Defines the folder name where ancillary build files will reside.

Copyright

Places a custom copyright notice in the Version dialog box of WinHelp.

Folder

Defines the folder name where the Help files will reside.

HubContents

Displays the name of the contents (.cnt) file to associate with the Help file.

MapFileForC

Creates C or C++ header files for context sensitive Help.

MapFileForVB

Creates Visual Basic header files for context sensitive Help.

MapNumbers

Determines whether a unique Context ID (map number) is generated for each topic.

Name

Returns a string containing the name of a specified Help target (read-only).

SkipGlossary

When True, omits the Glossary topic from the generated Help contents.

StyleSheet

Specifies the name of the cascading style sheet applied to intermediate files during compilation.

Template

The document template to apply to the intermediate files during compilation.

Title

Represents the title string of an object.

WinHelpMacro

Specifies a macro to run when a Help target, a topic, or secondary window is opened.

Natural Search Properties

AnswerCount

Determines the maximum number of answers to be returned when a natural language search is performed.

ConfidenceLevel

Sets the minimum score percentage that controls which answers will be displayed when a natural language search is performed.

SearchCaption

Specifies the text added to the tab caption (HTML Help) or button caption (WinHelp) when ComponentOne Natural Search is enabled.

SearchEnabled

Controls whether ComponentOne Natural Search is enabled.

StemPercent

Determines the number of characters (as a percentage of the total) that are added to the root word to create a new word group when building natural language search indexes.

StemSize

Determines the maximum number of characters used as a root word when building natural language search indexes.

StringNoMatch

Specifies the text used in the message box when ComponentOne Natural Search does not find a match for a question.

 

Navigation Properties

OneBrowseSequence

When True, this property provides a continuous browse sequence that spans multiple source documents.