Description

This proposal analyses how usable XWiki macros are from the WYSIWYG editor: how each macro is inserted, how its edit dialog is opened, what its parameters look like there, and what makes that experience harder than it should be. It results in a set of JIRA issues, macro by macro, and in a list of behaviours that differ between macros and should be made consistent.

The discussion behind this proposal happens on the forum: Consistency of the macro parameter table.

Scope and method

I currated this list to only contain macros that are completely open source, free, and kind of standard in the XWiki project: XWiki standard macros and the ones that are `Recommended`. This list and the following analysis was done on a XWiki 17.1.0-SNAPSHOT distribution ran locally.

Notably, I left out:

• macros that are deprecated and replaced by another one
• Macros from Pro extensions
• Macros from non recommended extensions

Contents of this proposal

• Cross-macro findings: the behaviours that differ between macros and should be made consistent, and the issues that apply to all macros.
• Per macro analysis: one page per macro, with its parameters, its dialogs, the problems found and the JIRA issues that cover them.
• Appendix - Discarded research: research gathered along the way that ended up not being used.