info
Audit
- Macro ID
- info
- Source
- XS
- Type
- Wrapper
- Classification reason
- Status
- In progress
- Criteria version
- 15.17
- XWiki version
- 18.8.0
- Audit date
- Auditor
- Compared macros
- warning 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 an info message note." repeats the name, and does not say that the message is shown in a highlighted box with an info icon. |
| D3 category | OK | |
| D4 quick-action | KO | Quick Actions finds the macro for "info" and the French name "Message d'information", under the name "Info Box": the macro name "Info Message" and the German name "Informationshinweis" give no result. The synonyms "note", "information", "callout" and "tip" do not find it. In the Insert Macro dialog, "note" finds it in 3rd position. |
| L1 consistency | OK | compared with warning and box. warning 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 | OK | |
| I3 instant | OK | |
| I4 cursor | KO | minor: after insertion from Quick Actions, the cursor is at the start of the default text "Type your information 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, {{info width="abc"}}This is an informational message{{/info}} renders with style="width:abc" and no error; {{info image="missing.png"}}This is an informational message{{/info}} renders a broken image, with no attachment missing.png on the page; {{info status="maybe"}}This is an informational message{{/info}} is read as false. |
| E3 nesting | KO | in a list item and in a table cell the info 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. CKEDITOR-267, content duplicated after deleting and undoing, is not part of the measure. |
| E6 inplace | KO | the content of a standalone info 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 info 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 | OK | OK | N/A | C1: shown as "CssClass" with the description "A CSS class to add to the box element", technical terms. The parameters inherited from box have no translation keys for the info macro, so the dialog shows the parameter ID in every language. |
| 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 | ||
| 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 |
Known issues of this macro
| Issue | Title | Status | Criteria |
|---|---|---|---|
| CKEDITOR-267 | Content gets duplicated for macros that can be inline edited, after deleting and undoing the deletion of content | Open | E5 |
| XWIKI-19959 | Selecting some text and clicking Insert > Info Box Macro should put the selected content in the macro content | Open | |
| 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.
Doc: https://extensions.xwiki.org/xwiki/bin/view/Extension/Info%20Macro#HUsage
Parameters:
- Message parameters
Quick action? ✅
Open the dialog with: Double click on the macro body.
Just inserted screenshot:
Default dialog screenshot:
Extended dialog screenshot:
JIRA issues
Query used to look for existing issues:
None
Issues that already existed:
None
Issues created by this analysis:
None
