\help\Topic\Overview.vl \help\Topic\HowTo Do Something.vl
We distinguish 2 types of patches:
In order to be picked up by the helpbrowser, those need to be put in the right place and follow the naming convention:
In a how-to patch select the node you want this patch to open for as a help patch and press Ctrl+H. This sets a high-priority help flag. Press a second time to change it to low-priority, press a third time, to clear the help flag again.
High vs. Low Priority
When pressing F1 on a node, the system will go through all help flags in all how-to patches of a library. If it encounters a high-priority help flag for the given node in a how-to patch, this patch will be displayed as the help patch. Therefore it only makes sense to specify a high-priority help flag once for each node!
After pressing F1, when the user decides to also view the Node Info for the node, the help browser will display a list of how-to patches that include the node with a low-priority help flag set. Therefor it makes sense to specify multiple low-priority help flags for the same node in different how-to patches to indicate that those could also be interesting when looking for use-cases of the given node.
Help flag indicator
Help flags can only be set on nodes that are defined in the same package as the one the how-to patch belongs to. If you try to set a help flag on a node that is not defined in the same package as the how-to patch you’re working on, you’ll see the following warning: