Details
-
Improvement
-
Resolution: Unresolved
-
Major
-
None
-
17.10.14, 18.8.0
-
None
-
Unknown
-
Description
Rarely used parameters of the Office and Translation 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:
- office: parameters declared in OfficeMacroParameters.java.
- translation: parameters declared in TranslationMacroParameters.java.
KOs covered
| Macro | Criterion | Parameters | Problem |
|---|---|---|---|
| office | C8 advanced | filterStyles | Not advanced, while it does not change what the macro does, only how the result is styled, and the calls of XWiki itself keep the default. Every example of the documentation sets it, to false, which the documentation should do less often, see L2. |
| translation | C8 advanced | locale | Not marked as advanced, although displaying a text in a fixed language is rare: no XWiki page sets it, only one example of the documentation. |
| translation | C8 advanced | scriptParameters | Not marked as advanced, although it only works inside a script macro and needs script right: it is for developers writing sheets. |
Impact found on macro fluidity
These 3 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.