Book Help properties - Cloud

Object Properties

The Help tab on the Properties window of a book contains properties that define how the Book object will be published on a Microsoft Windows online Help system. These properties define the title of the Help system, macros to be executed when the Help system is opened, file compression, file name and copyright information.

Book - Help Tab

Title

Defines the title that appears on the title bar of Windows Help.

Macro

Sets a relationship to a Macro Procedure object that defines the Windows Help Macros that will be executed each time the published Help system is started.

Compression

Allows you to select the type of compression used to compress the published Windows Help file.

File name

Defines the file name used to save both the main Help file (.hlp) and the contents file (.cnt). Do not include an extension in this file name.

Copyright information tab

The Copyright Information tab defines copyright information used in the published Windows Help system.

  • Help Copyright defines the copyright information that displays when the user selects About from the Help menu of Windows Help. It can contain a maximum of up to 255 characters.
  • Help Citation defines a citation that is appended to any text a user prints or cuts out of your Help system. It can contain a maximum of up to 2000 characters.

Copyright Information Tab

Linking tab

The Linking tab defines general information used when linking to the published Windows Help system from other sources.

Linking Tab

  • Help check prefixes defines prefixes other than IDH_ for mapped topic IDs. A prefix other than IDH_ generates errors as you compile your help file — unless you specify that prefix here.
  • Help include file defines the name and location of an ASCII text file that contains a list of items. Depending on the circumstances, the file can include mapped topic IDs. Including an ASCII text file provides an alternative to adding these items individually. If you do not know the name or location of the file you want to include, click the [...] button.
  • Topic ID offset specifies an offset number that Author-it will use when publishing Windows Help and HTML Help. The Topic IDs are set to the Object Code of the topic plus the specified offset. The main use for this property is if you are trying to combine multiple help files from different libraries and you want to ensure that the Topic IDs will not conflict.