box
Audit
- Macro ID
- box
- 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 warning
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 | OK | |
| D3 category | OK | |
| D4 quick-action | KO | Quick Actions finds the macro first for "box" and for the French name "Boîte". The synonyms "frame", "border", "panel" and "callout" give no result. |
| L1 consistency | OK | compared with info and warning. They insert a default text from their own Quick Actions entries and require their content, while box has an optional content and its Quick Actions entry inserts an empty {{box/}} , see I4. The parameters cssClass, image, title and width are the same, the message macros inherit them. The difference of the mandatory content is by design. |
| L2 doc-parameters | OK | |
| L3 doc-example | OK | |
| I1 pattern | OK | |
| I2 zero-config | KO | {{box/}} , inserted from Quick Actions or by the Edit Macro dialog submitted with the default values, shows a "macro:box" placeholder in the editor and renders nothing in view mode: the user expects a box on the page and sees none. |
| I3 instant | OK | |
| I4 cursor | KO | after insertion from Quick Actions ("/box", then Enter), the macro is inserted as {{box/}} , a non-editable "macro:box" placeholder with no content area: typed text goes after the macro, and the only way to add content is the Edit Macro dialog. |
| I5 focus | N/A | |
| E1 wysiwyg | OK | |
| E2 errors | KO | invalid values are accepted silently, with no message. For example, {{box width="abc"}}Text{{/box}} renders with style="width:abc", and {{box width="300"}}Text{{/box}} with style="width:300", which browsers ignore; {{box image="missing.png"}}Text{{/box}} renders a broken image, with no attachment missing.png on the page. |
| E3 nesting | KO | the box 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, like * {{box}}The content to put in the box.{{/box}} , the box is inline and its content cannot be edited in place. |
| E4 inline-support | OK | the macro declares inline support, and renders as a span inside a sentence, as in the documentation example The command is {{box cssClass="command"}}mvn clean install{{/box}} and nothing else. . |
| E5 empty | KO | the box inserted from Quick Actions has no content area: it is a "macro:box" placeholder that never receives the cursor, see I4. A content emptied in the editor, on the other hand, stays a full-width area that one click puts the cursor in. |
| E6 inplace | KO | the content of a standalone box is edited in place, but the Edit Macro dialog still shows it as a wiki syntax text area, also when editing an existing box. The content of an inline box, 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 box; the wiki syntax text area of the dialog is recorded under E6. |
| cssClass | OK | OK | OK | OK | OK | OK | N/A | KO | OK | N/A | C1: "A CSS class to add to the box element" uses technical terms, which fit a styling parameter: describing it another way would only be more confusing. C8: a styling parameter that is rarely used, and no common example sets it, but it is not marked as advanced. |
| image | KO | OK | OK | KO | OK | OK | N/A | OK | OK | N/A | C1: 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. C4: a free text field, with no image picker, although the type is a resource reference; a reference to a missing attachment is accepted. XWIKI-22863 proposes to deprecate the image of the box macro. |
| title | KO | OK | OK | OK | OK | OK | N/A | OK | OK | N/A | C1: 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. C6: the parameters are in alphabetical order, cssClass, image, title, width. 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", and "300" without a unit as style="width:300". |
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 |
|---|---|---|---|
| D4 | D4 quick-action | XWIKI-25444, XWIKI-25531 | |
| 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) | |
| E5 | E5 empty | XWIKI-24152 | |
| E6 | E6 inplace | XWIKI-19954 (partial) | XWIKI-25443 |
| C8:cssClass | C8 advanced, cssClass | XRENDERING-824 | |
| C1:image | C1 clarity, image | XWIKI-25492 | |
| C4:image | C4 input-assistance, image | XRENDERING-828 | |
| C1:title | C1 clarity, title | XWIKI-25492 | |
| 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 | E5 I4 | |
| XCOMMONS-3847 | New | E2 | |
| XRENDERING-823 | New | E2 | |
| XWIKI-25443 | New | E6 | |
| XWIKI-25444 | New | D4 | |
| XWIKI-25492 | New | C1:image C1:title | |
| 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 |
|---|---|---|---|
| CKEDITOR-266 | Hidden 'Content' parameter for 'Box' macro after pressing 'Change Macro' button | Open | C6 |
| CKEDITOR-296 | Cannot remove the box macro title once set | Open | |
| CKEDITOR-375 | Editing the home page shows a not rendered box macro | Open | E1 |
| XWIKI-24152 | Add a placeholder to the Box Macro | Open | E5 |
68 more known issues affect every macro: see the Known issues.
