success
Last modified by Lucas Charpentier on 2026/10/27 10:29
Audit
- Macro ID
- success
- Source
- XS
- Type
- Wrapper
- Classification reason
- Status
- Reviewed
- Criteria version
- 15.20
- XWiki version
- 18.8.0
- Audit date
- 2026-10-14
- Auditor
- Compared macros
- info box
Lucas CharpentierSources
Where to gather the information the criteria are checked against, see Gather the sources.
| Other sources specific to this macro |
|---|
|
| Criterion | Result | Notes |
|---|---|---|
| D1 wording | OK | |
| D2 summary | KO | 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. |
| D3 category | OK | |
| D4 quick-action | KO | Quick Actions finds the macro for "success" and the French name "Message en cas de succès", under the name "Success Box": the macro name "Success Message" gives no result. Of the synonyms, only "done" finds it; "note", "callout", "confirmation" and "ok" do not. |
| L1 consistency | OK | compared with info and box. info behaves the same, it shares the same Java class. box differs by design: its content is optional and its Quick Action inserts an empty box. |
| L2 doc-parameters | OK | |
| L3 doc-example | OK | |
| I1 pattern | OK | |
| I2 zero-config | KO | the content is mandatory, while an empty success box is a sensible result: {{success/}} written in the source renders "The required content is missing." instead of an empty box. In the Edit Macro dialog, Submit with an empty content does nothing and shows no message. |
| I3 instant | OK | |
| I4 cursor | KO | minor: after insertion from Quick Actions, the cursor is at the start of the default text "Type your success message here.", which is real content and is not selected: typing adds to it, and the user has to delete it. |
| I5 focus | N/A | |
| E1 wysiwyg | OK | |
| E2 errors | KO | invalid values are accepted silently, with no message. For example, {{success width="abc"}}This is a success message{{/success}} renders with style="width:abc" and no error; {{success image="missing.png"}}This is a success message{{/success}} renders a broken image, with no attachment missing.png on the page; {{success status="maybe"}}This is a success message{{/success}} is read as false. |
| E3 nesting | KO | in a list item and in a table cell the success macro is inline, and its content cannot be edited in place: the content span is not editable. A list, a table and a box can be edited inside its content. |
| E4 inline-support | OK | |
| E5 empty | OK | the emptied content stays a full-width area that one click puts the cursor in, and it saves and renders as an empty box. |
| E6 inplace | KO | the content of a standalone success macro is edited in place, but the Edit Macro dialog still shows it as a wiki syntax text area, also when editing an existing one. The content of an inline success macro can only be edited through that text area. |
Parameters
| Parameter | C1 clarity | C2 mandatory | C3 defaults | C4 input-assistance | C5 groups | C6 order | C7 alternatives | C8 advanced | C9 technical | C13 constraints | Notes |
|---|---|---|---|---|---|---|---|---|---|---|---|
| $content | OK | OK | N/A | OK | N/A | OK | N/A | N/A | N/A | N/A | |
| cssClass | KO | OK | OK | OK | OK | OK | N/A | KO | OK | N/A | C1: the message macros have no translation keys for the parameters inherited from box, so the dialog shows the parameter ID "cssClass" in every language. C8: a styling parameter that is rarely used, and no common example sets it, but it is not marked as advanced. |
| image | OK | OK | OK | KO | OK | OK | N/A | OK | OK | N/A | C4: a free text field, with no image picker; a reference to a missing attachment is accepted. |
| status | OK | OK | OK | OK | OK | OK | N/A | OK | OK | N/A | |
| title | OK | OK | OK | OK | OK | OK | N/A | OK | OK | N/A | |
| width | OK | OK | OK | OK | OK | OK | N/A | OK | OK | KO | C13: only accepts a CSS length "in px or %", but declares no format: "abc" is accepted and output as style="width:abc". |
KOs and tickets
Every KO needs a ticket covering it, see Report the KOs. One ticket can cover several KOs. Known issues filed for this macro are suggested in italics: link them as existing tickets when they cover the KO.
| KO | Criterion | Existing tickets | New tickets |
|---|---|---|---|
| D2 | D2 summary | XWIKI-25492 | |
| D4 | D4 quick-action | XWIKI-25444, XWIKI-25445 (partial), XWIKI-25531 (partial) | |
| I2 | I2 zero-config | XRENDERING-827 | |
| I4 | I4 cursor | XWIKI-24152 | |
| E2 | E2 errors | XCOMMONS-3847 (partial), XRENDERING-823 (partial), XRENDERING-826 (partial), XRENDERING-828 (partial) | |
| E3 | E3 nesting | XWIKI-19954, XWIKI-23309 (partial) | |
| E6 | E6 inplace | XWIKI-19954 (partial) | XWIKI-25443 |
| C1:cssClass | C1 clarity, cssClass | XWIKI-25492 | |
| C8:cssClass | C8 advanced, cssClass | XRENDERING-824 | |
| C4:image | C4 input-assistance, image | XRENDERING-828 | |
| C13:width | C13 constraints, width | XRENDERING-826 |
Tickets
| Ticket | Origin | KOs covered | KOs partly covered |
|---|---|---|---|
| XWIKI-19954 | Existing | E3 | E6 |
| XWIKI-23309 | Existing | E3 | |
| XWIKI-24152 | Existing | I4 | |
| XCOMMONS-3847 | New | E2 | |
| XRENDERING-823 | New | E2 | |
| XWIKI-25443 | New | E6 | |
| XWIKI-25444 | New | D4 | |
| XWIKI-25445 | New | D4 | |
| XWIKI-25492 | New | C1:cssClass D2 | |
| XRENDERING-824 | New | C8:cssClass | |
| XRENDERING-826 | New | C13:width | E2 |
| XRENDERING-827 | New | I2 | |
| XRENDERING-828 | New | C4:image | E2 |
| XWIKI-25531 | New | D4 |
Known issues of this macro
| Issue | Title | Status | Criteria |
|---|---|---|---|
| XWIKI-22028 | CKEditor / Xwiki 2.1 Syntax: Multi-paragraph Highlighting Boxes | Open |
68 more known issues affect every macro: see the Known issues.
