Properties
Previous Topic  Next Topic 

The Properties tab is located at the bottom of the help text editor. There are five tabs, "General", "HtmlHelp", "WinHelp", "Conditions" and "Keywords".


General tab

This tab is common to both WinHelp and HtmlHelp. Most fields cannot simply be edited by typing in them, because the text in these fields affects other Topics and Headings. So when they change, the changes may need to update other parts of your Project. So click on the [...] ellipsis buttons to make your changes. In this way you can change the Title, the HelpID and the Context String fields. You can also convert a Topic to a Heading and vice versa, by dropping down the arrow in the Page Type field and selecting the relevant option. The "Last Updated" field cannot be manually changed, but is updated whenever you make changes to your help text.


You can hide a Topic from the Contents list by checking the "Ghost" option. Your Topic will still be included in your help file, so you can link to it etc., but it will not be visible from the Contents.


Lock This Page: When this option is checked your page will be read-only, preventing further editing. This is a useful way to mark your pages as completed, indicating that they should no longer be changed.

Excluding pages when Compiling

Let's say you want to exclude a specific page when compiling your Project as a WinHelp file, but to include it in any other compile. Simply check the "WinHelp" option and when you next compile your settings will be adhered to. You can exclude any page from any of the listed compile formats simply by checking the relevant box. If a page has any compile option excluded then the contents entry will have a colored background to draw your attention to it.


When compiling Documentation - do not start this Topic on a new page.

When this option is checked, and you are compiling Documentation, this Topic will not start on a new page. This enhances the existing general options for page breaks on the Compile screen.


Tell AutoLinking to ignore this page

If AutoLinking is checked on the Compile screen then all Topics will be searched. If you do not want AutoLinking to search this page, then check this option and AutoLinking will skip this page.




HtmlHelp - Contents

Custom Image

If you want to, you can choose a different image for your Topic or Heading from up to 42 different choices. Use the drop down arrow to make your choice.

Window

This is a list of all the Windows that are maintained in "HtmlHelp Compiler Options". You can use this field to select one of these fields, such as a secondary window. When you compile and the user clicks on this contents entry, it will open in that window. You do not need to specify the Main window.

Alternative URL

If, for some reason the contents entry is not available or incorrect, the user will be shown this alternative URL.

Frame

Although Fast-Help does not directly support Frames, this option is included for completeness so that if you choose to you can make use of this option.


HtmlHelp - Override Project Background Color

The background color is determined by the Main window in "HtmlHelp Compiler Options". But if you want to override an individual page then you can do it with this option.


HtmlHelp - Override Project Background Image

The background image is managed in "Project Settings", but you can override it for an individual page with this option.


HtmlHelp - This is an External File

Let's say you have a carefully crafted html file that uses features that Fast-Help does not support. You want to use it in your Project but not loose any formatting. Copy it to your "HtmlHelp" folder, beneath your installation folder and use this option to point to it.




WinHelp - Contents

Help File

Use this option to point your contents entry to another .HLP file.

Window

This is a list of all the Windows that are maintained in "WinHelp Compiler Options". You can use this field to select one of these fields, such as a secondary window. When you compile and the user clicks on this contents entry, it will open in that window. You do not need to specify the Main window.

Macro

If you are knowledgeable about macros you can use this field to type in the WinHelp macro.


WinHelp - Footnotes

Browse Name

You can group WinHelp topics together by using a common browse name.

Browse ID

The browse id is the sequence that the browse buttons on the WinHelp toolbar follow.

A Footnote

If you want to make use of this special footnote simply type your footnote text in here.

B Footnote

If you want to make use of this special footnote simply type your footnote text in here.

Topic Macro

If you are knowledgeable about macros you can use this field to type in the WinHelp macro.

Custom Footnote

This is a catch-all field. In the first field you can type in any single letter for your own footnote. In the second field type in the footnote text.


See Also

Conditions

Keywords