MindTouch F1 contextual help allows you to add contextual help to your application, site or anywhere you need to serve help content to your users.
MindTouch F1 contextual help
MindTouch F1 contextual help allows users to see MindTouch content wherever F1 contextual help is deployed, including from within an application or a site. Articles, images and videos display in a contextual help window, so that your users don't have to leave the application or site to get the help they need.
At the top of the F1 contextual help dialog, the user has five (5) options to navigate through the F1 dialog:
- Back allows the user to navigate to the previous article in F1 if they clicked on a link or navigated to a new location in the dialog.
- Forward allows the user to return to a page that they visited after they selected Back.
- Home will take the user to the Home page for your MindTouch site.
- Open Article will open the current article that you are looking at in a new browser Tab/Window and surface through the MindTouch site.
- Search allows the user to search for any article within MindTouch and then view the article within F1 (see more about search below).
Searching in F1 contextual help
Not only can users view articles within F1 contextual help, but they also have the ability to search from within the F1 contextual help window so that they can find and view articles without leaving your application:
When creating a DNS record for this sub-domain, point this F1 sub-domain as a CNAME to
lb.mindtouch.us. This is similar to how your primary domain is configured. Once created, this sub-domain will never need to be referenced when creating F1 links, though is required behind the scenes for F1 links to successfully resolve.
Anchors allow users to link to a specific sections of a page. F1 contextual help does not currently support the ability to link to anchors within pages.
F1 contextual help links will not successfully resolve when using your temporary domain. As best practice, we recommend configuring a custom domain for your site, as well as configuring an SSL.
When adding an SSL for your custom domain, you need to obtain a Subject Alternate Name (SAN) SSL certificate, which includes the F1 contextual help sub-domain. Be sure to read our SSL configuration documentation for further details.