Details
-
Improvement
-
Resolution: Unresolved
-
Major
-
None
-
17.10.14, 18.8.0
-
None
-
Unknown
-
Description
Two rarely used parameters of the Async and Cache macros are shown with the main options of the Edit Macro dialog instead of as advanced parameters.
The macros to change, with the file where most of the fix is done:
- async: parameters declared in AsyncMacroParameters.java.
- cache: parameters declared in CacheMacroParameters.java.
KOs covered
| Macro | Criterion | Parameters | Problem |
|---|---|---|---|
| async | C8 advanced | id | The parameter shares one cached result between several pages, a rare need, and no call of the macro in XWiki Standard sets it, but it is shown with the main options instead of as an advanced parameter. |
| cache | C8 advanced | maxEntries | No example of the documentation sets it, and the cache it sizes is shared by every call with the same time to live and the same size, so it is a rare tuning, shown with the main options instead of as an advanced parameter. |
Impact found on macro fluidity
These 2 KOs come from the WYSIWYG usability audit of the macros, under the criteria 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.