HelpContextID Element

Publish

Platform_KC
On Premises

Description

Allows you to define an alternative context ID for the topic. By default, the context ID is the Object Code of the topic. This context ID can be used when linking in to your help file. The Context ID field supports 50 numeric characters.

Note: Alias Name and Context String fields can contain both alpha and numeric characters, while the Context ID field can only contain numeric characters.

The HelpContextID element corresponds to the "Context ID" 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 50 characters (should contain digits)

Sample XML

<HelpContextID inherited="true">0</HelpContextID>