MindTouch F1 Contextual Help allows you to add contextual help, served directly from your MindTouch site, within your application, site, and anywhere that 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 is deployed including within an Application or a site. Not only do the articles show within the site, but also images and videos so that your users don't have to leave the Application/Site to get the help they need.
At the top of the F1 dialog, the user has 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
Not only can users view articles within F1, but they also have the ability to search within the F1 Dialog so that they can find and view articles without leaving your application:
Before purchasing an SSL for your custom domain, there a few considerations to take into account. Depending on the MindTouch features you'll be using with your custom domain, you may need to obtain a specific SSL certificate. A shared SSL is included for all MindTouch.Us domains: https://*.mindtouch.us
Configuring an SSL with a Custom Domain
When configuring your MindTouch site with a custom domain (e.g., "help.domain.com") as well as an SSL for your custom domain, the complimentary https://*.mindtouch.us domain will no longer redirect to your custom domain. If your site is utilizing a custom domain without an SSL, then the complimentary https://*.mindtouch.us domain will redirect accordingly.
MindTouch requires that SSL certificates be SHA-256 compatible. Please be sure your SSL is created with this encryption level support.
SSL providers often times request what type of web server the SSL will need to be generated for; in these instances choose an option for Apache.
If your site is using a custom domain then you will need to configure an SSL for your custom domain and reference your custom domain over HTTPS.
SSL Required? Yes
Required SSL Type: Subject Alternate Name (SAN) (for custom domains)
F1 Contextual Help
MindTouch.us Domain and F1
F1 Contextual Help within a *.mindtouch.us domain cannot be loaded if a site is Private and/or if you are targeting a page which requires authentication. When logged into a MindTouch site utilizing the mindtouch.us domain, users are redirected to HTTPS. The SSL included with the mindtouch.us domain is incompatible with F1 Contextual Help.
If you require your site to be private or you're trying to access a page which requires authentication, you will need to configure a custom domain.
Custom Domain and F1
F1 Contextual Help within a custom domain can be successfully loaded if the site is public and/or if you are targeting a page which does not require authentication.
If you require F1 Contextual Help to be loaded over a custom domain for a site that is private and/or if you are targeting a page which requires authentication, a Subject Alternate Name (SAN) SSL certificate is required. This type of certificate is required as information from your site will be served from both your main domain (e.g. "help.example.com") and your F1 domain (e.g. "f1.help.example.com").