Help Section
About This Section
This collapsible section allows you to do the following:
-
Add a help link to a step or introduction using either a help document link
or help context ID as input.
-
Remove a help link from a step or introduction.
-
Edit the help document link or help context
ID used as input to add a help link to a step or introduction.
This section is accessible by selecting a step or introduction node in the Content section.
Section Fields
This section contains the following fields:
Type
|
Combo Box
|
Help Link Type
|
Select <none> to remove a help
link from a step or introduction.
Consequently, the Value input field
will no longer be visible.
Select Help Context ID to make the
Value input field visible right under
this field and ready to accept a help context ID as input.
Select Help Document Link to make the
Value input field visible right under
this field and ready to accept a help document link as input.
|
No
|
Value
|
Text
|
Help Document Link Value or Help Context ID Value
|
If Help Context ID is selected in the
Type field, specify a valid help
context ID in this field to add a help link to a step
or introduction.
In the Cheat Sheet view,
clicking on a step or introduction's help link created
using a help context ID will open that help
context ID in the Help view.
The format of a valid help context ID is the following:
<plugin-id>.<help-context-id>
If Help Document Link is selected in the
Type field, specify a valid help
document link in this field to add a help link to a step
or introduction.
In the Cheat Sheet view,
clicking on a step or introduction's help link created
using a help document link will open that help
document link in the Help Infocenter.
The format of a valid help document link is the following:
/<plugin-id>/<path>/<html-file>
|
No
|
Example of a help link removed from a step or introduction.
Note: This section is collapsed by default when no help context ID or
help document link is specified.
Example of a help link added to a step or introduction defined using a help context ID as input.
Note: This section is expanded by default when a help context ID is specified.
Example of a help link added to a step or introduction defined using a help document link as input.
Note: This section is expanded by default when a help document link is specified.
Representation
An introduction with a help link and various steps with help links are
represented in the Cheat Sheet view as follows:
Note: A help link created using a help context ID is
indistinguishable from one created using a help document link
in the Cheat Sheet view.
Relevant Links