HelpJumpMacro Element

Publish

Platform_KC
On Premises

Description

Allows you to choose how this topic will be displayed when you jump to it from the Help contents. You can choose:

  • Display as a Popup: the topic will be displayed as a pop-up.
  • Show only as a heading: no topic will be created in Windows Help, only an entry in the contents is created.
  • Display in the Default Window: the topic will be displayed in the window defined in Topic Help Window.
  • Do not show in contents: a topic is created in the Windows Help, but this topic will not appear in the contents. This can be used for What's This Help topics and other topics that you don't want in the contents. (This setting is also used in HTML outputs.)

    Note: Child topics or books beneath the topic (which is set not to show in the contents) "inherit" the same behavior and are also hidden in the contents. Also, if a sub book is included in the contents of another book, the sub book's title will not appear in the main book contents, only the topics inside that book.

Execute this Macro: allows you to set a relationship to a Macro Procedure object to be executed. A topic is still created but the macro may not necessarily display the topic.The HelpJumpMacro element corresponds to the "Execute this Macro" field, on the Display and Contents 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

Integer

>= 0 (an Object ID)

Sample XML

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