This issue has been created
 
 
XWiki Platform / cid:jira-generated-image-avatar-5319e44b-6c12-468d-b290-3a404d8c5efc XWIKI-25474 Open

Reorganize the Edit Macro dialog of the Attachment Selector macro

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-3d409c10-dd85-48b0-bdfe-c5371b4d9c2e Charpentier Lucas created this issue on 22/Oct/26 11:58
 
Summary: Reorganize the Edit Macro dialog of the Attachment Selector macro
Issue Type: cid:jira-generated-image-avatar-5319e44b-6c12-468d-b290-3a404d8c5efc Improvement
Affects Versions: 17.10.14, 18.8.0
Assignee: Unassigned
Components: Attachments
Created: 22/Oct/26 11:58
Priority: cid:jira-generated-image-static-major-0bbdb177-fcd7-43b1-ad94-418c4ca00a2e Major
Reporter: Charpentier Lucas
Description:

The Edit Macro dialog of the Attachment Selector macro shows its optional fields in a single group, in alphabetical order: the fields set by the documented example are below the fold, the image checkbox opens unchecked while every use sets it, and the rarely used fields are not marked as advanced.

KOs covered

Macro Criterion Parameters Problem
attachmentSelector C8 advanced object An object number is needed only on a page that carries several objects of the class, which the examples of XWiki Standard never do, and the parameter is not advanced.
attachmentSelector C5 groups cssClass, buttontext, filter, displayImage, width, height, alternateText, link, targetdocname, versionSummary In the single Optional parameters tab with every other optional field: the parameters used together, like the image display options, are not grouped.
attachmentSelector C8 advanced cssClass A styling hook that no example sets, not marked advanced.
attachmentSelector C6 order savemode The example sets it, and it switches between the two uses of the macro, but the dialog sorts the fields alphabetically and shows it below the fold, after the fields filter, height, link and object.
attachmentSelector C8 advanced buttontext The label of the button is changed now and then, and the parameter is not advanced.
attachmentSelector C6 order filter The example sets it, but the dialog shows it below the fold.
attachmentSelector C3 defaults displayImage The checkbox opens unchecked, while the most common example and every use of XWiki Standard that shows an image set displayImage="true".
attachmentSelector C6 order width The example sets it, but the dialog shows it below the fold, last of the optional fields.
attachmentSelector C8 advanced height Set rarely, since the examples set the width only, and not advanced.
attachmentSelector C8 advanced alternateText Set now and then, only for an image, and not advanced. It comes first in the dialog, before the fields of the example.
attachmentSelector C8 advanced link Used in one documented example, and not advanced.
attachmentSelector C8 advanced targetdocname Set rarely, and not advanced.
attachmentSelector C8 advanced versionSummary Asks for a history comment, set rarely, and not advanced.

Impact found on macro fluidity

These 22 KOs come from the WYSIWYG usability audit of the macros, under the criteria C3 defaults, C5 groups, C6 order, 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.