Uploaded image for project: 'Hippo CMS'
  1. Hippo CMS
  2. CMS-15680 Implement contextual documentation link for components
  3. CMS-15693

Front-end: use documentation link in Experience Manager for components

    XMLWordPrintable

Details

    • Sub-task
    • Status: Closed
    • Normal
    • Resolution: Fixed
    • None
    • 15.5.0, 16.0.0
    • None
    • None
    • 4
    • Orion
    • Orion.Cycle8.Sprint3, Orion Cycle Gap
    • Undetermined

    Description

      Per CMS-15692, a documentation link (and possibly a documentation text) will be exposed to the front-end on component level.

      Use it to create a clickable  icon, possibly with hover text.

      This should be on the same level as the HST-Label for which this exists in community/channel-manager/frontend-ng/src/app/model/entities/component-entity.js:

      getLabel() {
        const label = this._meta[HstConstants.LABEL];
        if (label === 'null') {
        return this.getType(); // no label available, fallback to type.
        }
      
        return label;
      }

      which gets the label from the HTML comments in the site preview (AFAICS).

      So the back end should add an extra attribute there and the front-end can use it.

      Above is changed, now using the

      /_rp/<component-id>./hippo-default/<locale>

      call to expose the documentationLink.

      Attachments

        Issue Links

          Activity

            People

              jhoffman Jeroen Hoffman
              jhoffman Jeroen Hoffman
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: