Skip to main content

Create and configure a contextual help Touchpoint

theresa manzo
Written by Theresa Manzo
Product Manager at MindTouch
This page applies to:MindTouch Responsive

This article describes how to create and configure the contextual help Touchpoint.
 

Prerequisites


  • Administrative access to the control panel of your MindTouch site
  • Touchpoints enabled on your site
  • Site configured for HTTPS over SSL (Secure Sockets Layer)
  • Contextual help configured on your domain
     

Create your contextual help Touchpoint 


Perform the following steps to create and configure the contextual help Touchpoint: 

Step 1: Access the control panel

  1. From the MindTouch toolbar, select Site toolsControl panel.

Screenshot of the control panel option selected in toolbar
 

  1. Navigate to Navigate to System Settings > Integrations >Touchpoints Contextual Help.

Screenshot of contextual help touchpoint option in control panel
 

  1. Review the contextual help configuration fields:

Screenshot of the contextual help touchpoint configuration dialog
 

Step 2: Configure the contextual help Touchpoint

Configure the contextual help link:

  • Name. Unique name to easily identify the Touchpoint.
  • Host. Host name or domain where the Touchpoint will be embedded. (You may use comma separated host names and wildcards.)

If you want to apply a Touchpoint throughout your site and all subdomains, do NOT enter www.<yourdomain>.com.  Instead, enter <yourdomain>.com.

  • Custom CSS selector.  CSS class name that identifies your contextual help links that trigger your contextual help dialog (by default, the CSS selector is .F1).

You must reference the CSS selector as a class within the clickable image or text for the contextual help dialog to open.

 

Step 3: Configure the help dialog navigation

To display the Back, Forward, Home and Open article buttons in the contextual help window, perform the following steps :

  • Select the Yes radio button.
  • Enter the label you want the navigation item to display on larger screens.
  • Enter the tooltip text you want to display when users hover over the navigation item (and on smaller screens when label text can no longer be displayed).
     

Step 4: Configure the help dialog search box

 

To display the Touchpoint search box, perform the following steps :

  • Select the Yes radio button.
  • Enter the search path URL the hierarchy to which you want to restrict a user's initial search) path.
  • Enter the text you want to display in the search box.

The search location is NOT the page the contextual help dialog displays upon opening the Touchpoint. The search location specifies the hierarchy in which users can search for information. If you want the contextual help dialog to also display this page upon opening the Touchpoint, you must also specify this URL as your href  attribute when embedding your Touchpoint. 

 

Step 5: Create the contextual help Touchpoint

Click Add this Touchpoint
 

Step 6: Copy your embed code

When prompted, click Copy code to clipboard to copy the embed code of your contextual help Touchpoint. 

Image of prompt to copy the contextual help embed code

To review your Touchpoint configuration or copy the embed code later, navigate to System Settings > IntegrationsTouchpoints Currently enabled Touchpoints.

 

 

Step 7: Embed your contextual help Touchpoint

To embed the Touchpoint into your web page or application, follow the steps outlined in our article on embedding contextual help Touchpoints.

 

  • Was this article helpful?