This issue has been created
 
 
XWiki Platform / cid:jira-generated-image-avatar-2531295b-a0a6-4222-bbd3-d9e64f014379 XWIKI-25576 Open

Add a page picker for the PageReference parameters of the Edit Macro dialog

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-7ae6033f-e638-4be8-a58d-299ea34ef2dd Charpentier Lucas created this issue on 23/Oct/26 16:15
 
Summary: Add a page picker for the PageReference parameters of the Edit Macro dialog
Issue Type: cid:jira-generated-image-avatar-2531295b-a0a6-4222-bbd3-d9e64f014379 Improvement
Affects Versions: 17.10.14, 18.8.0
Assignee: Unassigned
Components: Display, Rendering - Include Macro, WYSIWYG Editor
Created: 23/Oct/26 16:15
Priority: cid:jira-generated-image-static-minor-ab5934de-cd6c-47a0-83a8-81d0a8205cae Minor
Reporter: Charpentier Lucas
Description:

The include and display macros have a deprecated page parameter, an alternative to their reference parameter. It is hidden from the Edit Macro dialog of a new macro, but shown when an existing macro sets it, like {{include page="Sandbox/TestPage1"/}}, the first example of the include documentation. It is declared with the PageReference display type, which has no picker, so the dialog shows a plain text field next to the page picker of the reference alternative.

The parameters are hidden for this very reason, as the comment above setPage in IncludeMacroParameters.java says: "ATM we don't have a picker for PageReference types". The display macro does the same in DisplayMacroParameters.java.

The improvement is a page picker for the PageReference display type, an html_displayer template for pagereference reusing the picker of documentreference. The priority is low: most users never see the deprecated parameter, and only these two parameters use the type. XWIKI-25477 covers the other problem of the same case, the two fields with the same name and description.

KOs covered

Macro Criterion Parameter Problem
include C4 input-assistance page When an existing macro sets the deprecated page parameter, the dialog shows it as a plain text field, while the reference alternative next to it has a page picker.
display C4 input-assistance page When an existing macro sets the deprecated page parameter, the dialog shows it as a plain text field, while the reference alternative next to it has a page picker.

Impact found on macro fluidity

These 2 minor KOs come from the WYSIWYG usability audit of the macros, under the criterion C4 input-assistance of its usability criteria, which asks that each parameter uses an appropriate input, such as a picker. The page of each macro, linked in the table, has the full notes.