|
| Summary: |
Declare search keywords for the box and message macros |
| Issue Type: |
 Improvement |
| Affects Versions: |
17.10.14, 18.8.0 |
| Assignee: |
Unassigned |
| Components: |
Rendering - Box Macro |
| Created: |
23/Oct/26 10:49 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The box and message macros cannot be found in Quick Actions or in the Insert Macro dialog with the words users have in mind for them. A user who types "callout", "note", "alert" or "panel" gets no result, or other macros, and can conclude that XWiki has no such box. The macros to change, with the file where most of the fix is done:
- box, info, warning, error and success: names and descriptions translated in the ApplicationResources.properties of xwiki-platform oldcore, where the keywords go next to them.
The main problems:
- Common synonyms of a message box, like "callout" and "note", find none of the five macros.
- The words of each kind of message are missing: "tip" for info, "alert" and "caution" for warning, "danger", "failure" and "problem" for error, "confirmation" and "ok" for success, "frame", "border" and "panel" for box.
- "note", "caution" and "fail" list unrelated macros, like Footnote, Notifications or Dashboard, instead of the message macros.
Searching by the name of the message macros, like "Info Message", is a separate problem covered by XWIKI-25445. Depends on
- XWIKI-25444, which lets a macro declare translated search keywords and makes Quick Actions and the Insert Macro dialog match them.
KOs covered
| Macro |
Criterion |
Parameter |
Problem |
Depends on |
| box |
D4 quick-action |
|
Found by "box" and the French name "Boîte", but the synonyms "frame", "border", "panel" and "callout" give no result. |
XWIKI-25444 |
| error |
D4 quick-action |
|
The synonyms "alert", "danger", "failure", "problem" and "callout" do not find it, and "fail" lists Notifications and Dashboard entries. |
XWIKI-25444 |
| info |
D4 quick-action |
|
The synonyms "note", "information", "callout" and "tip" do not find it in Quick Actions. |
XWIKI-25444 |
| success |
D4 quick-action |
|
Of the synonyms, only "done" finds it; "note", "callout", "confirmation" and "ok" do not. |
XWIKI-25444 |
| warning |
D4 quick-action |
|
The synonyms "note", "callout", "alert" and "caution" do not find it, and "note" and "caution" list Footnote and Notifications. |
XWIKI-25444 |
Impact found on macro fluidity These 5 KOs come from the WYSIWYG usability audit of the macros, under the criterion D4 quick-action 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 adding the search keywords to the translations of the macros, once XWIKI-25444 lets them declare keywords. |
|
