You are here: Working with Projects > Help Target Properties > HTML Help

HTML Help

This target produces Microsoft HTML Help, which requires Internet Explorer to be installed on the client machine. Internet Explorer version 3.0 is acceptable, but 4.0 or greater is preferred.

Appearance Properties

BackGroundColor

Displays the current background color setting for the Help pane.

BackgroundImage

Displays the image file to be used as a background in the Help pane.

BackGroundRepeat

Defines how the background image is arranged in the Help pane.

Theme

Determines the appearance of the Help pane and framesets for HTML-based targets.

Build Properties

AttributeExpression

Specifies an advanced conditional build expression for a help target.

BinaryIndex

When True, generates a binary index instead of a site map index.

BinaryTOC

When True, generates a binary table of contents instead of a site map table of contents.

GenerateCSS

When set to False, the existing cascading stylesheet will not be overwritten when building the 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

Accessibility

Determines whether special features for 508 compliance are enabled.

BreadcrumbsLabel

Specifies the text that precedes topic breadcrumbs.

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.

 

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.

DefaultWindow

Specifies the default window definition for the compiled help file.

GraphicsScaleWithFonts

When set to True, all graphics in Word source documents are resized proportionally when system font size is changed.

ImageFormat

Determines graphic format in which images originated from Word source documents are stored in image files in the online help target.

ScaleGraphics

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

TopicsFound

Determines whether Alink/Klink topic lists are displayed in a dialog box (default) or a pop-up menu.

Localization Properties

Charset

Specifies one of the character set aliases listed in HTML Character Sets and Named Entities.

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 HTML Help target files. By default, this name will be the same as the file name for the Help project itself.

CopyFolder

Defines the folder name where ancillary build files will reside.

Folder

Defines the folder name where the Help files will reside.

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.

 

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.

 

Strings Properties

StringNext

Allows modification of the next string value.

StringPrevious

Allows modification of the previous string value.