Creating Element - Specific Help Topics

Define a string value referring to an element-specific help topic for each DSL element:

• By clicking the Help button in the element’s Specification window.
• By pressing F1, when the element’s symbol is selected.

To define a help topic ID for the DSL element

1. Select the appropriate customization element and open its Specification window.
2. In the general specification pane, select the Help ID property and type the help topic ID text.

3. Click Close when you are done. After updating the customization element specification, you must either reuse the DSL Customization profile in the model or reopen the model. 

   

   The Help ID property is connected to the documentation.server path variable, the default value of which is https://docs.nomagic.com. The opened link is constructed in this way: '<documentation.server value> + /display/MD<modeling_tool_version>/ + <help ID text>'.
   Accessing such a link via F1 or Help buttons opens the specified documentation page.

If an element represents two or more DSL elements, the first DSL element’s help topic ID will be taken.

If the DSL type customization does not have the Help ID property defined, the help topic ID derives from the more general stereotype customization (ancestor) of the Help ID property. If there is no ancestor, the metaclass help opens.

Related pages

• Using Customization Data
• Creating Customization Data