HelpContextString Element

Author-it XML

Platform_KC
On Premises

Description

Allows you to define an alternative context string for the topic. By default, the context string is the Object Code of the topic prefixed with the letter "O", for example, "O123". This context string can be used when linking in to your help file.

The HelpContextString element corresponds to the "Context String" field, on the Linking sub-tab, on the Windows Help tab, of the Topic object.

Attributes

Attribute Name

Optional

Data Type

inherited

Yes

Boolean

Parent Element

Topic

Values

Data Type

Range

String

0 to 255 characters long.

Sample XML

<HelpContextString>MainPage<HelpContextString>