Skip to main content

Create and configure a contextual help button Touchpoint

This article describes how to create and configure contextual help button Touchpoints.
 

Currently, contextual help buttons CANNOT be branded. If you want to use custom styled buttons, use contextual help Touchpoints and style as desired. 

 

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  the contextual help button Touchpoint 


Perform the following steps to create and configure the contextual help button 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 System Settings > Integrations >Touchpoints > Contextual Help with Help Button.

Screenshot of contextual help button touchpoint option in control panel
 

  1. Review the contextual help button configuration dialog fields:

Screenshot of contextual help button touchpoint configuration dialog
 

Step 2: Configure the contextual help button

Fill out the following fields to configure the help button:

  • 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.

  • Help button label. Text you want your help button to display.
  • Help button path. URL of the MindTouch page you want the contextual help dialog to display.

Do not enter a content ID (CID) in Help button path field. CIDs are not compatible with the contextual help button.

 

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.
     

Step 5: Create the contextual help button 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 button Touchpoint. 

Screenshot of prompt to copy the contextual help button touchpoint embed code

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


Step 7: Embed your contextual help button Touchpoint

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