Skip to main content
MindTouch Success Center

Embedded Contextual Help

Extend a MindTouch page into a third-party website or application for embedded access without a pop-up needed to view the content.

Prerequisites

Use Cases

Embed your MindTouch content into any webpage or app where you want MindTouch-powered content to display side-by-side in another interface. Different from the Contextual Help Touchpoint that triggers a pop-up viewer on top of the interface, Embedded Contextual Help displays the MindTouch content inline.

  • Navigate or interact through MindTouch content embedded in another interface.
  • Useful in e-commerce site or anywhere that a user is trying to accomplish a task.
  • Used inside CRM/Contact Center Integrations to display articles after search results are clicked.
  • Can programmatically display dynamically chosen content (if needed, contact your Customer Success Manager).
  • Inline container displays the page you designated during setup.
  • Users can further navigate content on your site:
    • Back.  Displays the page previously viewed in the contextual help dialog.
    • Forward.  Displays the next page viewed in the contextual help dialog.
    • Home.  Takes users to the home page of your MindTouch site.
    • Open article.  Opens the current article inside your MindTouch site in a new tab or window.

Limitations

  • No native search functionality
  • No custom CSS available but will load CSS from MindTouch site

Implement Embedded Contextual Help Touchpoint

  1. Navigate to Site Tools > Dashboard > Integrations > Touchpoints Management.
  2. Select Create a Touchpoint > Embedded Contextual Help > Select Type.
  3. Fill in the configuration fields:
    • Name - A unique name to easily identify the Touchpoint.
    • Host - Host name or domain where the Touchpoint will be embedded (comma-separated host names and wildcards are allowed).
    • Description - Optional description.
    • Display navigation buttons - Select to include navigation options within the embedded page (Back, Forward, Home, Open article).
    • Height, Width - Specify desired embedded size
    • Display 'Open in MindTouch' button
    • Starting page hierarchy location
  4. Select Add this Touchpoint > Copy code to clipboard.
    Screenshot of the contextual help touchpoint embed code
  5. Embed the Touchpoint code into the HTML of any web property or application for which that Touchpoint is configured. The code must be placed in the body section, not the head section of your HTML.
  • Was this article helpful?