|
| Description: |
The name parameter of the Template macro is optional in its descriptor, but the macro renders nothing without it, with no message.
h2. KOs covered
||Macro||Criterion||Parameters||Problem||
|[template|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/template/]|C2 mandatory|{{name}}|Not mandatory in the descriptor, but nothing works without it: no name renders nothing, with no message, and the legacy documentation says it is mandatory. No default would work for the example, so it should be mandatory; the dialog then refuses an empty value, and Quick Actions opens the dialog as for include and uiextension, which also fixes I2. Reproduce: Quick Actions, Template inserts {{{{template/}}}}.|
|[template|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/template/]|I2 zero-config| |{{{{template/}}}}, inserted from Quick Actions or by the Edit Macro dialog with the default values, renders nothing in view mode, with no message, and shows only the generic "macro:template" placeholder in the editor: the user cannot tell that a name is missing. Making the name mandatory fixes it.|
h2. Impact found on macro fluidity
These 1 2 KOs come from the [WYSIWYG usability audit of the macros|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/], under the criteria C2 mandatory , I2 zero-config of its [usability criteria|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Usability%20criteria/]. 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. |
|
