Skip to main content

Create and configure a contextual help link

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

This article describes how to create and configure a contextual help link to embed into your web properties and applications.

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 link


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

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.
  2. Review the contextual help configuration fields:

Screenshot of the contextual help touchpoint configuration dialog

Step 2: Configure the contextual help link

Enter your configuration information:

  • Name. Unique name to easily identify the contextual help link.
  • Host. Host name or domain where the contextual help link 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.

  • Custom CSS selector.  CSS class name that identifies your contextual help link that triggers 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 contextual help navigation

To display the Back, Forward, Home and Open article buttons in the contextual help dialog, 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 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 when clicking the contextual help link. 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 initially, you must also specify this URL as your href  attribute when embedding your tool. 

Step 5: Create the contextual help link

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

Image of prompt to copy the contextual help embed code

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

 

Step 7: Embed your contextual help link

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

  • Was this article helpful?