|
| Summary: |
Improve the descriptions of the box and message macros and of their parameters |
| Issue Type: |
 Improvement |
| Affects Versions: |
17.10.14, 18.8.0 |
| Assignee: |
Unassigned |
| Components: |
Rendering - Box Macro |
| Created: |
22/Oct/26 12:09 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The descriptions of the box and message macros, and of their parameters, are what the Insert Macro and Edit Macro dialogs show to explain them. The descriptions of the four message macros repeat their names, two box parameters call the box a message box, and the cssClass parameter the message macros inherit from box has no translation. The macros are defined in xwiki-rendering, but their translations are in xwiki-platform. The macros to change, with the file where most of the fix is done:
KOs covered
| Macro |
Criterion |
Parameters |
Problem |
| box |
C1 clarity |
image |
The description "the image which is to be displayed in the message box" calls the box a message box, which it is not, and does not say what value is expected, an attachment or a URL. |
| box |
C1 clarity |
title |
The description "the title which is to be displayed in the message box" calls the box a message box, which it is not. It does not say either that the title accepts wiki syntax. |
| error |
D2 summary |
|
The description "Displays an error message note." repeats the name, and does not say that the message is shown in a highlighted box with an error icon. |
| error |
C1 clarity |
cssClass |
The message macros have no translation keys for the parameters inherited from box, so the dialog shows the parameter ID "cssClass" in every language. |
| info |
D2 summary |
|
The description "Displays an info message note." repeats the name, and does not say that the message is shown in a highlighted box with an info icon. |
| info |
C1 clarity |
cssClass |
The message macros have no translation keys for the parameters inherited from box, so the dialog shows the parameter ID "cssClass" in every language. |
| success |
D2 summary |
|
The description "Displays a success message note." repeats the name, and does not say that the message is shown in a highlighted box with a success icon. |
| success |
C1 clarity |
cssClass |
The message macros have no translation keys for the parameters inherited from box, so the dialog shows the parameter ID "cssClass" in every language. |
| warning |
D2 summary |
|
The description "Displays a warning message note." repeats the name, and does not say that the message is shown in a highlighted box with a warning icon. |
| warning |
C1 clarity |
cssClass |
The message macros have no translation keys for the parameters inherited from box, so the dialog shows the parameter ID "cssClass" in every language. |
Impact found on macro fluidity These 10 KOs come from the WYSIWYG usability audit of the macros, under the criteria C1 clarity, D2 summary 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 translations of the macros and, for a name or a category, their definitions. |
|
