error
Audit
- Macro ID
- error
- 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
- warning info
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 an error message note." repeats the name, and does not say that the message is shown in a highlighted box with an error icon. |
| D3 category | OK | |
| D4 quick-action | KO | Quick Actions finds the macro for "error", "err", the French name "Message d'erreur" and the German word "Fehler", but under the name "Error Box": the macro name "Error Message" and the German name "Fehlerhinweis" give no result. The synonyms "alert", "danger", "failure", "problem" and "callout" do not find it, "fail" lists Notifications and Dashboard entries. In the Insert Macro dialog, "note" finds it in 1st position. |
| L1 consistency | OK | compared with warning and info. Both behave the same, they share the same Java class. |
| L2 doc-parameters | OK | |
| L3 doc-example | OK | |
| I1 pattern | OK | |
| I2 zero-config | KO | the content is mandatory, while an empty error box is a sensible result: {{error}}{{/error}} renders "Failed to execute the [error] macro. Cause: [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. Quick Actions inserts a default text, and a content emptied in the editor saves and renders as an empty box. |
| I3 instant | OK | |
| I4 cursor | KO | minor: after insertion from Quick Actions, the cursor is at the start of the default text "Type your error message here.", which is real content and is not selected: typing adds to it, and the user has to delete it. Saving without editing keeps the default text in the page. |
| I5 focus | N/A | |
| E1 wysiwyg | OK | |
| E2 errors | KO | invalid values are accepted silently, with no message. For example, {{error width="abc"}}This is an error message{{/error}} renders with style="width:abc" and no error; {{error image="missing.png"}}This is an error message{{/error}} renders a broken image, with no attachment missing.png on the page; {{error status="maybe"}}This is an error message{{/error}} is read as false. Only an empty content gives an error. |
| E3 nesting | KO | the error macro renders in a list item, a table cell and a box, and a list, a table and a box render and can be edited inside its content. But in a list item and in a table cell it is inline, and its content cannot be edited in place: the content span is not editable. |
| E4 inline-support | OK | |
| E5 empty | OK | the emptied content stays a full-width area that one click puts the cursor in. |
| E6 inplace | KO | the content of a standalone error 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 error macro, in a sentence, a list item or a table cell, 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 | C4: edited in place for a standalone error macro; the wiki syntax text area of the dialog is recorded under E6. |
| 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. C9: no documentation example uses it. A realistic use is styling one message on an application page, which targets developers: it could rather be 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, for example {{error image="missing.png"}}This is an error message{{/error}} . |
| 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 | C6: the parameters are in alphabetical order, cssClass, image, title, width, status. The most common example sets none of them, so the order is OK per the measure, but title is the one users are most likely to set. |
| 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: {{error width="abc"}}This is an error message{{/error}} is accepted by the dialog 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 | |
| XWIKI-23623 | Table cell actions not available in WYSIWYG when inside macro with in-line editable content | Open | E3 |
68 more known issues affect every macro: see the Known issues.
