This article shows how to add contextual help to your applications or other web pages.
Contextual help is now enabled by default in MindTouch.
This solution assumes you have already created a page in MindTouch with the content that you want to show in the contextual help window:
- If your MindTouch site uses a
mindtouch.usdomain (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 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.
How to add contextual help
Step 1: Loading the script
You must load the 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.
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 contextual help window, create a hypertext link to the MindTouch page that contains the help content and add the
F1 class. Insert the following code into the
<body>target="_blank" section of the page where you want the contextual help link to appear:
(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>
You must use a capital
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 contextual help window: Learn more about MindTouch contextual help.