Contextual help is content sourced from our content management system and displayed in the product interface. You can work with product teams to add help popovers in the Experience Cloud or Experience Platform product UI. The help content is managed in documentation markdown files. It can include links to docs and videos.
In this Experience Platform page, the following
CONTEXTUALHELP element appears below the Mandatory attributes section.
Open the markdown file that you want to use as the target file for the Learn more URL.
CONTEXTUALHELP blurb below the target heading, as shown in this example:
Requirements and guidelines for authoring contextual help:
|id||The ID that the developer adds to the product page. Work with developers to determine this value. See Developer requirements below.
The suggested ID format is:
|title||The title that displays at the top of the popover. This title must match the interface element or the task or concept heading associated with the element.|
|abstract||The definition that displays below the title. This description should be brief, one paragraph, with no more than five lines, and include UICONTROL and DNL tags where needed. Do not embed more than three links.
Begin the first line as an abstract definition, meaning, a noun phrase that is not a complete sentence. (Similar to how definitions are authored in this table.) For example, assume you are defining Real-Time Analytics Data:
Within the description, you can link to other related help, tutorials, or courses. However, for the
|additional-url||The markdown file used in the Learn more link. You can create a goURL to use a goURL instead that links to a documentation or video page.|
The Developer should add the JS library front-end for the whole app. This needs to be done only once.
The developer and documentation teams should coordinate information icon locations and IDs (described in the preceding table) to connect the UI with the documentation page.
<ContextualHelp entryId="id_value" />
The popover look is defined in the library. It is compliant with spectrum/global UX recommendations. The overall look helps ensure UX homogeneity.
The popovers have been implemented in Campaign and Customer Journey Orchestration. This wiki page is the main entry:
The JS script description and integration is documented here: