Major Description
The Edit Macro dialog of the mention and useravatar macros opens fields empty without showing the default they stand for, and shows the generated anchor and the type of mention with the main options.
The macros to change, with the file where most of the fix is done:
- mention: parameters declared in its wiki macro definition, MentionsMacro.xml.
- useravatar: parameters declared in UserAvatarMacroParameters.java.
KOs covered
| Macro | Criterion | Parameters | Problem |
|---|---|---|---|
| mention | C3 defaults | anchor | The field opens empty, and the examples set a different value for each mention, like xwiki-XWiki.Admin-123456, so no single default exists. The dedicated "Mention" entry generates one, like XWiki-Admin-quqyis, which the dialog could preselect. An empty anchor gives the id $escapetool.xml($anchor) unexpanded, see E2. |
| mention | C8 advanced | anchor | Set in the most common example, but a value that the editor generates and that users do not choose, so rarely edited and not marked as advanced. |
| mention | C3 defaults | type | The field opens empty, which stands for "user", the value of every use in XWiki Standard. Nothing in the dialog shows it. |
| mention | C8 advanced | type | Not advanced, while its only value in XWiki Standard is the default one and extensions are the only reason to change it. |
| useravatar | C3 defaults | height | The field opens empty, which stands for the height of the uploaded picture, a value the dialog does not show and that depends on each user's upload: an avatar of 300 by 200 pixels shows at that size. Every use sets a size, 40 in the documentation examples and a width of 100 in the release sheet of XWiki Standard, but no single value is used in most cases. |
| useravatar | C3 defaults | width | The field opens empty, which stands for the width of the uploaded picture, a value the dialog does not show and that depends on each user's upload: an avatar of 300 by 200 pixels shows at that size. Every use sets a size, 40 in the documentation examples and a width of 100 in the release sheet of XWiki Standard, but no single value is used in most cases. |
Impact found on macro fluidity
These 6 KOs come from the WYSIWYG usability audit of the macros, under the criteria C3 defaults, 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.