| The comment macro renders nothing, so the WYSIWYG editor shows only the generic "macro:comment" placeholder: reading or changing a comment needs opening the Edit Macro dialog, where it is a plain text area. For example, {{comment}}Remember to update this table every release.{{/comment}} shows only "macro:comment" in the editor. The fix is done in CommentMacro.java: when the macro is rendered for the WYSIWYG editor, output the text of the comment in an area that is edited in place and styled as a comment, while view mode keeps rendering nothing. XWIKI-25523 is related: it standardizes how a macro knows that it is rendered for the WYSIWYG editor. KOs covered
| Macro |
Criterion |
Problem |
| comment |
E6 inplace |
The content is never shown in the editor, which only displays "macro:comment": reading or changing a comment needs the Edit Macro dialog, where it is a plain text area. |
Impact found on macro fluidity This KO comes from the WYSIWYG usability audit of the macros, under the criterion E6 inplace of its usability criteria, which asks that the content is edited in place, with an editing experience suited to its data, not in a text area of the Edit Macro dialog. The page of the macro, linked in the table, has the full notes and the steps to reproduce. It is also needed by XWIKI-25563, so that the Quick Action can insert the macro without the Edit Macro dialog. |