Uploaded image for project: 'XWiki Platform'
  1. XWiki Platform
  2. XWIKI-25503

Offer the chart types, the Live Data sources and layouts and the dashboard styles as lists in the Edit Macro dialog

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 17.10.14, 18.8.0
    • Chart, Dashboard, Live Data
    • None
    • Unknown

    Description

      The chart, liveData and dashboard macros take values from a list in free text fields of the Edit Macro dialog, so the user has to know the accepted values, and a wrong one fails when the macro renders or gives "(No entries)".

      The macros to change, with the file where most of the fix is done:

      The main problems:

      • The type and source of chart are fixed lists, which a Java enum would turn into a select with no other change: they do not depend on another ticket.
      • The Live Data sources are components, and the layouts a list of several values, so their values have to come from a provider.
      • The style of dashboard has one predefined value, panels, but accepts any CSS class, so it needs suggestions with free input.

      Depends on

      Most of these fields cannot be offered before these generic changes, each giving the macro the means to declare the expected value:

      • XWIKI-23045, which lets a parameter get its values from a provider, with or without custom values.

      KOs covered

      Macro Criterion Parameter Problem Depends on
      chart C4 input-assistance type A free text field for one of the 12 chart types, where a select, ideally with a preview of each type, could be used: Pie is accepted and fails at rendering. -
      chart C4 input-assistance source A free text field for inline or xdom, where a select could be used: source="foo" is accepted and fails at rendering. -
      liveData C4 input-assistance source A plain text field for one of the installed Live Data sources, which a select could offer. XWIKI-23045
      liveData C4 input-assistance layouts A plain text field for a list taken from table and cards, which checkboxes or a multiple select could offer. XWIKI-23045
      dashboard C4 input-assistance style A plain text field, while the only predefined value, panels, is given in the description only: a field suggesting it and accepting any CSS class would show it. XWIKI-23045

      Impact found on macro fluidity

      These 5 KOs come from the WYSIWYG usability audit of the macros, under the criterion C4 input-assistance of its usability criteria. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the declaration of the parameters in the macro definitions.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              Lucas C Charpentier Lucas
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: