With VisualSP, you can create an inline help item within the context of a page.
Here are the steps to creating your own inline help item.
As a subscription administrator, you will need to confirm your subscription has inline help activated.
- Go to Manage My Subscriptions from the hamburger menu in the help panel
- Scroll down to the Application Settings section and toggle the Enable Inline Help to Yes:
To create an inline help item, create a help item as you normally would, but toggle the Enable Inline Help / Tooltip to yes:
When inline help is toggled to yes, additional options will appear in the help editor. First you will need to select an element to attach the inline help icon to:
This element selector acts in the same manner as the element selector in the walkthrough editor.
For some media types, you will also see two additional items you can configure: Display as Tooltip and Position:
Additional configuration options are available by clicking the Toggle inline Help Icons Advanced Properties link, and the options available will depend upon the Media Type selected for the help item.
- Show in Main Help Panel. Toggling this option to yes will add this help item to the Help panel
- The Trigger drop down options include Click, Hover (automatically close on mouse out), and Hover (users must click close button to close)
- Icon Z-Index. Helpful to bring the help icon forward if it is hidden behind an element. Can also be fixed by adjusting the element selected by narrowing or expanding selection:
- Toggle Hide Arrow to No to hide the tooltip arrow.
- Tooltip Size allows you to adjust the bubble size to better hold the content of the help item
- Tooltip Offset allows you to adjust the tooltip left and right offset
Inline Help Best Practices/Tips
- If help item won’t be displayed in help panel, assign Inline Help as the category name. This will organize inline help into a single category and makes them easier to find. Best practice is to NOT display an inline help item in the help panel because:
— Inline help gives user a more intuitive understanding of what the help item will be about, vs the help panel, which must be deduced by reading and understanding the text description
— Declutters the help panel
— By assigning Inline Help as the group name, makes it easier to find all your inline help items under one category
- For testing purposes, see if element selector moves/changes if another element is clicked (for example, a document is selected, which changes the ribbon options). If it does, solution is to uncheck “Ignore text” from the element selector configuration.