Uploaded image for project: 'Hippo CMS'
  1. Hippo CMS
  2. CMS-7662

Provide description/tooltip info for component parameters

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Normal
    • Resolution: Fixed
    • None
    • 13.1.0
    • None
    • None
    • Tiger
    • Tiger Sprint 196 - Hardening, Tiger Sprint 197, Tiger Sprint 198, Tiger Sprint 199

    Description

      The org.hippoecm.hst.core.parameters.Parameter annotation has a org.hippoecm.hst.core.parameters.Parameter#description method that is used nowhere. A description or tooltip for component parameters would be useful though, like we have for the channel manager properties.

      Suggestions from Mathijs:
      Tou typically want to translate such tooltips in all CMS languages. For channel properties that's already possible by including additional labels that end with .help [1]. A similar mechanism could be made for component properties.

      I propose to deprecate the #description method, although it could work as a fallback. But would you expect that to work this way as a developer?

      [1] http://www.onehippo.org/7_8/library/concepts/channels/additional-channel-information.html

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              bleunis Bert Leunis (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: