Help Target

When you created a new project, you specified what kind of help target you wanted to create. If you would like to change the type of help target, use the Help Target drop-down box to select your desired type of help target.

Target Properties

Output

BaseName

Base file name to be used for generating help target files.

Caption

String to be displayed in the caption bar of the help window.

Appearance

Template

Specifies the name of the document template applied to intermediate files during compilation.

StyleSheet

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

Theme

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

Natural Search

On/Off

Select On to generate Natural Search indexes for a Help target and add a custom tab (HTML Help) or button (WinHelp) to the Help file.

Localization

Clicking the Localization button opens the Localization window. This window allows you to modify the appearance of strings that appear in the help target. The options on this tab are specific to the type of target that you are creating. If you do not wish to modify the strings in the help target, you can continue on to the Build tab. 

 

Help 2.0

 

Display

ButtonLabel

Specifies the text that precedes the subtopic buttons.

Manual

OnPage

Specifies the default text used when completing a cross-reference.

Misc

StringNext

Allows modification of the Next string value.

 

StringPrevious

Allows modification of the Previous string value.

 

HTML Help

 

Display

ButtonLabel

Specifies the text that precedes the subtopic buttons.

Manual

OnPage

Specifies the default text used when completing a cross-reference.

Misc

SearchCaption

Specifies the text added to the tab caption when ComponentOne Natural Search is enabled.

 

StringNext

Allows modification of the Next string value.

 

StringNoMatch

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

 

StringPrevious

Allows modification of the Previous string value.

 

JavaHelp

 

Display

ButtonLabel

Specifies the text that precedes the subtopic buttons.

Manual

OnPage

Specifies the default text used when completing a cross-reference.

Misc

StringContents

Allows modification of the Contents string value.

 

StringFavorites

Allows modification of the Favorites string value.

 

StringFoundMany

Allows modification of the %d topics found: string value.

 

StringFoundOne

Allows modification of the 1 topic found: string value.

 

StringFoundZero

Allows modification of the No topics found. string value.

 

StringIndex

Allows modification of the Index string value.

 

StringNext

Allows modification of the Next string value.

 

StringPrevious

Allows modification of the Previous string value.

 

StringReturnToIndex

Allows modification of the Return to Index string value.

 

StringSearch

Allows modification of the Search string value.

 

Manual

 

Manual

OnPage

Specifies the default text when completing a cross-reference.

Misc

StringContents

Allows modification of the Contents string value.

 

StringIndex

Allows modification of the Index string value.

 

NetHelp

 

Display

ButtonLabel

Specifies the text that precedes the subtopic buttons.

Manual

OnPage

Specifies the default text used when completing a cross-reference.

Misc

StringContents

Allows modification of the Contents string value.

 

StringFoundMany

Allows modification of the %d topics found: string value.

 

StringFoundOne

Allows modification of the 1 topic found: string value.

 

StringFoundZero

Allows modification of the No topics found. string value.

 

StringIndex

Allows modification of the Index string value.

 

StringIndexCaption

Represents the string to be displayed in the Index window above the index text box.

 

StringNext

Allows modification of the Next string value.

 

StringNoMatch

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

 

StringPrevious

Allows modification of the Previous string value.

 

StringReturnToIndex

Allows modification of the Return to Index string value.

 

StringSearch

Allows modification of the Search string value.

 

StringSearchCaption

Represents the string to be displayed in the Search window above the search text box.

 

StringSearchGo

Represents the string to be displayed in the search button within the Search window.

 

StringSyncToc

Allows modification of the Sync TOC string value.

 

WinHelp

 

Display

ButtonLabel

Specifies the text that precedes the subtopic buttons.

Manual

OnPage

Specifies the default text used when completing a cross-reference.

Misc

SearchCaption

Specifies the text added to the button caption when ComponentOne Natural Search is enabled.

 

StringNoMatch

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

 

Title

Represents the string to be displayed in the caption bar of the help window.

More Properties

The More Properties button opens the Properties window for the help target. This window allows you to customize the appearance of the help window. Like the Localization window, the options on this window are specific to the type of target that you are creating.

 

Help 2.0

There are no additional properties for Help 2.0

 

HTML Help

 

Buttons

ShowBackButton

When selected, the Back button is included in the help window.

 

ShowForwardButton

When selected, the Forward button is included in the help window.

 

ShowHideShowButton

When selected, the Hide and Show buttons are included in the help window.

 

ShowNextButton

When selected, the Next button is included in the help window.

Note: The BinaryTOC property must be set to True for the navigation buttons to function.

 

ShowPreviousButton

When selected, the Previous button is included in the help window.

Note: The BinaryTOC property must be set to True for the navigation buttons to function.

 

ShowPrintButton

When selected, the Print button is included in the help window.

Tabs

FavoritesTab

When enabled, the Favorites tab is added to the help window.

 

SearchTab

When enabled, the Search tab is added to the help window.

 

SearchTabAdvanced

Adds additional functionality to the search tab.

 

JavaHelp

 

Tabs

ContentsTab

When enabled, the Contents tab is added to the help window.

 

FavoritesTab

When enabled, the Favorites tab is added to the help window.

 

IndexTab

When enabled, the Index tab is added to the help window.

 

SearchTab

When enabled, the Search tab is added to the help window.

 

Manual

 

Title Page

ByLine

Specifies the byline text used on the title page of printed manuals.

 

SuperTitle

Specifies the text that appears above the title string on the title page of printed manuals.

 

Title

Represents the title string of an object.

Note: This property sets the text that appears below the SuperTitle string on the title page.

 

NetHelp

 

HTML

DefaultFile

File name to be used as part of the base URL for the HTML target. (Usually default.htm or index.html)

Tabs

ContentsTab

When enabled, the Contents tab is added to the help window.

 

IndexTab

When enabled, the Index tab is added to the help window.

 

SearchTab

When enabled, the Search tab is added to the help window.

 

WinHelp

 

Buttons

ShowBackButton

When selected, the Back button is included in the help window.

 

ShowBrowseButtons

When selected, the Browse buttons are included in the help window.

 

ShowContentsButton

When selected, the Contents button is included in the help window.

 

ShowFindButton

When selected, the Find button is included in the help window.

 

ShowHelpTopicsButton

When selected, the Help Topics button is included in the help window.

 

ShowIndexButton

When selected, the Index button is included in the help window.

 

ShowOptionsButton

When selected, the Options button is included in the help window.

 

ShowPrintButton

When selected, the Print button is included in the help window.