This solution assumes you have already created a page in MindTouch with the content that you want to show in the F1 contextual help window:
- If your MindTouch site uses a mindtouch.us domain (if the URL for your MindTouch site looks like: example.mindtouch.us), then the MindTouch page that contains the help content must not be Private or require authentication. You must load the F1 script on any application to access.
- If your MindTouch site uses a private domain (if the URL for your MIndTouch site looks like: help.example.com), then the page that contains the help content can be Private or require authentication to access as long as you create an additional CNAME record in your DNS entries for the F1 subdomain (for example, f1.help.example.com). You also must add the CNAME record to your DNS entries if your custom-domain site uses SSL encryption.
Step 1: Loading the F1 Script
You must load the F1 script on any application or web page where users click a link to see an F1 contextual help window. Insert the following code into the
<body> section of the page.
Tip: To delay-load the script so the page doesn't load it until the rest of the page has rendered, insert this code immediately before the closing
Step 2: Creating the Link
To let users access the F1 contextual help window, you create a hypertext link to the MindTouch page that contains the help content and add then add the F1 class. Insert the following code into the <body>target="_blank"section of the page where you want the F1 link to appear
s to create links to the help pages you want to show on your site. Simply use the
<a> element with a
href and add class="F1". We also recommend you use
target="_blank" to open the help link in a new tab, but it's not required.
<a class="F1" href="URL of the MindTouch page that contain the help content" target="_blank">Text of the link</a>
Note: You must use a capital F in class=F1.
The example link below was created using this HTML code:
<a class="F1" href="https://success.mindtouch.com/Documentation/Integration/F1/F1_Contextual_Help/Adding_F1_Contextual_Help_in_2_easy_steps" target="_blank">Learn about MindTouch F1</a>
Click the following example link to see the F1 contextual help window: Learn about MindTouch F1
When utilizing F1 Contextual Help, you will need to ensure an F1 sub-domain exists for your account (e.g. f1.success.mindtouch.com). 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.
The complimentary SSL included with *.mindtouch.us domains is not compatible with F1 Contextual Help. As such, F1 links will not successfully resolve when using your temporary domain. For best practices we recommend configuring a custom domain for your site, as well as configuring an SSL.
When adding an SSL for your custom domain, you will need to obtain a Subject Alternate Name (SAN) SSL certificate, which includes the F1 sub-domain.
Please be sure to read our SSL configuration documentation for further details.