Cross-macro findings

These are the conclusions drawn from the per macro analysis: the behaviours that differ from one macro to the next and should be made consistent, and the issues that apply to every macro rather than to a single one.

Consistency comparison

• Hints for boolean parameters
  • Enable or disable : async
• Control pattern for opening the edit dialog
  • Double click on the macro body (excluding the content box): (default)
  • Click on the dropdown appearing when focusing the macro: async
• Generic style only parameters
  • width: attachmentSelector, box
  • height: attachmentSelector
  • cssClass: attachmentSelector, box

Generic macro issues

These issues affect macros in general, through the editor, the Insert Macro dialog, the Quick Actions, the macro list or the macro system, rather than a single macro. They come from the criteria discussion on the forum and from a search of the open XWIKI, XRENDERING and CKEDITOR issues that mention macros. Issues specific to one macro are listed on that macro's page instead.

Discovery: Quick Actions, Insert Macro dialog, macro list

Insertion

Edit Macro dialog and parameters

Editing and rendering in the editor

Errors

Technical limitations

Technical limitations that make a criterion fail on every affected macro. The criterion is recorded KO, with a note linking here.

• Wiki macros cannot declare constraints (C13): a parameter of a wiki macro cannot declare a range or a format, so a number like the limit of documentTree accepts any text. Workaround: none until XWIKI-25197; a parameter with a typed input, like a select or a picker, cannot get an invalid value from the dialog and is OK. Found on: documentTree, documents, children, menu, tree.

Reported generic problems

Technical limitations and generic bugs found while auditing the macros, for which no ticket existed, and the ticket reported for each. The criterion they affect is recorded OK, with a note linking here.

• The content cannot be an alternative of a parameter (C7): a parameter that replaces the content, like source of the code macro, cannot be grouped with the content as one choice in the Edit Macro dialog, since only parameters can be part of a feature. Found on: code, content, context. Reported as XWIKI-25456.
• No picker for CSS values (C4): parameters that take a CSS value, like the width and height of box and gallery, are plain text fields. A picker for CSS lengths, and other CSS values, needs brainstorming, design and implementation. Found on: box, gallery. Reported as XWIKI-25457.
• The page picker shows the title of another translation (C4): in the English UI, searching "Test Page 1" in the page picker of the Edit Macro dialog suggests "Sandkasten Test Seite 1", the German title of Sandbox.TestPage1, and "TestPage1" suggests "Página de Prueba 1", the Spanish one, instead of the English title. Likely a bug of the generic page picker, shared by every macro with a page field. Found on: display, include. Reported as XWIKI-25458.