Skip to main content

Create and configure a contextual help button tool

This article describes how to create and configure a contextual help button to embed in your web properties and application.
 

Currently, contextual help buttons CANNOT be branded. If you want to use custom styled buttons, use the contextual help tool 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
     

How to create the contextual help button 


Perform the following steps to create and configure your contextual help button: 

Step 1: Access the Touchpoint toolbox

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

Screenshot of the control panel option selected in toolbar

  1. Navigate to System Settings > Integrations >Touchpoint Toolbox > Contextual Help Button.
  2. Review the contextual help button configuration dialog fields:

Screenshot of contextual help button touchpoint configuration dialog

Step 2: Configure the contextual help button

Enter the following information:

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

To apply a Touchpoint tool throughout your site and all subdomains, do NOT enter www.<yourdomain>.com.  Instead, enter <yourdomain>.com.

  • Help button label. Text you want your contextual 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 the Help button path field. CIDs are not compatible with the contextual help button.

Step 3: Configure contextual help 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 contextual help search

To display the contextual help search bar, 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

Click Add this Touchpoint tool

Step 6: Copy your embed code

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

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

To review your contextual help button configuration or to copy the embed code later, navigate to System Settings > Integrations >Touchpoint Toolbox Currently enabled Touchpoint tools.

Step 7: Embed your contextual help button

To embed the contextual help button into your web page or application, follow the steps in our article outlining how to embed your contextual help button.

  • Was this article helpful?