|
| Summary: |
Reorganize the Edit Macro dialog of the chart, liveData and dashboard macros |
| Issue Type: |
 Improvement |
| Affects Versions: |
17.10.14, 18.8.0 |
| Assignee: |
Unassigned |
| Components: |
Chart, Dashboard, Live Data |
| Created: |
22/Oct/26 11:59 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The Edit Macro dialog of the chart, liveData and dashboard macros puts the essential fields among the display options, and some defaults do not match what the macro does. The macros to change, with the file where most of the fix is done:
The main problems:
- liveData has its 13 fields in a single group, and the three parameters every example sets, source, sourceParameters and properties, are below the fold.
- The showPageSizeDropdown checkbox of liveData opens unchecked, so the dialog hides a drop-down the macro shows by default, and the params field of chart opens empty, which fails for the table of the documented example.
- The layout, source and style parameters of dashboard are for advanced use, as the documentation says, but are not marked as advanced.
KOs covered
| Macro |
Criterion |
Parameters |
Problem |
| chart |
C3 defaults |
params |
The field opens empty, which stands for the whole table, header row and label column included, and fails for the table of the most common example: {{chart type="pie"}} with that table renders "Invalid number: [].". The example needs range:B2-D5, or range:B2-.. for the whole data, a value no field preselects. |
| dashboard |
C8 advanced |
layout |
Rarely used and not marked as advanced: it should be advanced at the very least. The documentation says "This parameter is for advanced usage, should be left empty for basic use cases." |
| dashboard |
C8 advanced |
source |
The documentation says "This parameter is for advanced usage, should be left empty for basic use cases.", and XWiki Standard sets it only from sheets, like source="$xcontext.user", but it is not marked as advanced. |
| dashboard |
C8 advanced |
style |
A styling parameter that is rarely used, set by no use of the macro in XWiki Standard, but it is not marked as advanced. |
| liveData |
C5 groups |
description, filters, id, layouts, limit, offset, pageSizes, properties, showPageSizeDropdown, sort, source, sourceParameters |
The 13 fields, content included, are all in the single group "Optional parameters", above 7 ± 2, with the essential ones, source, sourceParameters and properties, mixed with the display options. The same holds for every parameter. |
| liveData |
C6 order |
properties |
One of the three parameters every example sets, it is the 9th of the 13 fields, below the fold. |
| liveData |
C3 defaults |
showPageSizeDropdown |
The checkbox opens unchecked and the dialog then inserts showPageSizeDropdown="false", which hides the "Results per page" drop-down, while the macro shows it when the parameter is not set, as in the most common example. |
| liveData |
C6 order |
source |
One of the three parameters every example sets, it is the 12th of the 13 fields, below the fold. |
| liveData |
C6 order |
sourceParameters |
One of the three parameters every example sets, it is the last field, below the fold. |
Impact found on macro fluidity These 20 KOs come from the WYSIWYG usability audit of the macros, under the criteria C3 defaults, C5 groups, C6 order, C8 advanced 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 parameter declarations of the macros: their groups, order, default values, mandatory and advanced flags. |
|
