|
| Description: |
The type of the mention macro is a free text field of the Edit Macro dialog with a single value in XWiki Standard, user, which extensions can add to.
The main problem:
* A wiki macro cannot declare the list, and the types come from extensions, so a provider with the installed types is needed.
A value outside these lists must also fail when the macro renders, with an error that names the parameter and lists the accepted values, instead of being ignored or giving a technical message. The style, a fixed list of name formats, has the same problem as the type.
h2. 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.
h2. KOs covered
||Macro||Criterion||Parameter||Problem||Depends on||
|[mention|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/mention/]|C4 input-assistance|{{type}}|A free text field with one predefined value, user, that a select could offer: {{type="robot"}} is accepted and shows the raw reference.|XWIKI-23045|
|[mention|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/mention/]|E2 errors|{{type}}, {{style}}|style="maybe", "NICK" or "" falls back to the full name with no message, and type="robot" renders the raw reference instead of the name. Partly covered, see below.| |
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 criterion criteria C4 input-assistance and E2 errors 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 declaration of the parameters in the macro definitions.
The E2 errors KO of mention is only partly covered here, for the type and the style. The same KO also reports other invalid values, covered by the other issues listed on the page of the macro, among them XCOMMONS-3847 for the conversion of the values and XRENDERING-823 for the wording of the error. |
|
