warning
Audit
- Macro ID
- warning
- Source
- XS
- Type
- Wrapper
- Classification reason
- Status
- Reviewed
- Criteria version
- XWiki version
- 18.8.0
- Audit date
- 2026-10-13
- Auditor
- Compared macros
- info box
Sources
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 warning message note." repeats the name, and does not say that the message is shown in a highlighted box with a warning icon. |
| D3 category | OK | |
| D4 quick-action | KO | Quick Actions finds the macro for "warning", "warn" and the French name "Message d'avertissement", but under the name "Warning Box": the macro name "warning message" gives no result. The synonyms "note", "callout", "alert" and "caution" do not find it, "note" and "caution" list Footnote and Notifications. In the Insert Macro dialog, "note" finds it in 6th position. |
| 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 shown as "macro:box", while warning inserts a default text. Macros of the same type do not need the same features, so these differences are not a KO. |
| L2 doc-parameters | OK | |
| L3 doc-example | OK | |
| I1 pattern | OK | warning is the reference wrapper macro. From Quick Actions ("Warning Box") and from Insert > Warning Box, it is inserted directly with a default text. From Insert > Other Macros, the Edit Macro dialog opens with a required Content text area. |
| I2 zero-config | OK | Quick Actions inserts a default text, so there is no error box. In the Edit Macro dialog, Submit with an empty content does nothing and shows no message. A content emptied in the editor saves and renders as an empty box, but an empty content written in the source renders "The required content is missing." |
| I3 instant | OK | |
| I4 cursor | KO | minor: after insertion from Quick Actions, the cursor is at the start of the default text "Type your warning 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, {{warning width="abc"}}This is a warning message{{/warning}} renders with style="width:abc" and no error; {{warning image="missing.png"}}This is a warning message{{/warning}} renders a broken image, with no attachment missing.png on the page; {{warning status="maybe"}}This is a warning message{{/warning}} is read as false. Only an empty content gives an error. |
| E3 nesting | KO | the warning 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 the warning is inline, and its content cannot be edited in place: the content span is not editable and typed text is lost. |
| E4 inline-support | OK | the macro declares inline support, and renders as a span inside a sentence. |
| E5 empty | OK | |
| E6 inplace | KO | the content of a standalone warning is edited in place, but the Edit Macro dialog still shows it as a wiki syntax text area, also when editing an existing warning. The content of an inline warning, 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 warning; the wiki syntax text area of the dialog is recorded under E6. |
| cssClass | KO | OK | OK | OK | OK | OK | N/A | OK | OK | N/A | C1: shown as "CssClass" with the description "A CSS class to add to the box element", technical terms. The message macros have no translation keys for the parameters inherited from box, so the dialog shows the parameter ID in every language; the box keys themselves name it "cssClass" in English. 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. XWIKI-22863 proposes to deprecate the image of the box macro. |
| 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: "abc" 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 | ||
| D4 | D4 quick-action | ||
| I4 | I4 cursor | ||
| E2 | E2 errors | ||
| E3 | E3 nesting | Known: XWIKI-23623 | |
| E6 | E6 inplace | ||
| C1:cssClass | C1 clarity, cssClass | ||
| C4:image | C4 input-assistance, image | ||
| C13:width | C13 constraints, width |
Tickets
| Ticket | Origin | KOs covered |
|---|---|---|
| New | D2 |
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 |
69 more known issues affect every macro: see the Known issues.
