gallery
Audit
- Macro ID
- gallery
- Source
- XS
- Type
- Wrapper
- Classification reason
- Status
- Reviewed
- Criteria version
- 15.20
- XWiki version
- 18.8.0
- Audit date
- 2026-10-15
- Auditor
- Compared macros
- figure container
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 | the macro is in the Layout category, like container, which fits it: a gallery is not as technical as figure, which is in Development. |
| D4 quick-action | KO | Quick Actions finds the macro first for "gallery" and for the French and German name "Galerie", and first for the synonyms "slideshow", "images" and "slider". The synonyms "carousel", the word the documentation uses for the slide-show, and "photos" give no result. |
| L1 consistency | KO | compared with figure and container. Both have an optional rich text content edited in place and are inserted by their Quick Action without a dialog, while the gallery content is mandatory and uses a format of its own, a plain text listing images in wiki syntax, like image:[email protected] one per line, so its Quick Action opens the Edit Macro dialog, see I3 and E6. None of the three declares a default value. |
| L2 doc-parameters | KO | the parameters are only documented on the legacy extensions.xwiki.org page, not in the new documentation. Its parameter table does not list the content, nor that it is mandatory, and gives the 620px and 349px defaults of width and height, which the macro descriptor does not declare: they come from the gallery stylesheet. |
| L3 doc-example | OK | the Usage example {{gallery}}image:alice.png ... {{/gallery}} renders without error, with broken images when the attachments do not exist; the audit used it with existing images. The RSS example fails on XWiki Standard with "Unknown macro: rss", since the RSS macro is not bundled. |
| I1 pattern | KO | the reference wrapper, warning, is inserted by its Quick Action without a dialog; the gallery Quick Action opens the Edit Macro dialog, see I3. It follows the generic behavior of macros without a dedicated Quick Action, like comment. |
| I2 zero-config | OK | the dialog cannot be submitted with the default values, since the content is mandatory and empty: it stays open, with no message, the generic behavior of the dialog. {{gallery/}} renders with no error. |
| I3 instant | KO | inserting from the Quick Actions menu with "/gallery" and Enter opens the Edit Macro dialog with an empty Content text area; the macro is only inserted after typing image references in wiki syntax and submitting. |
| I4 cursor | KO | after submitting the dialog, the macro widget is selected and the cursor is not in its content: the content cannot be typed in place, see E6. |
| I5 focus | N/A | |
| E1 wysiwyg | KO | the editor shows the images of the content stacked one under the other, with no slide-show frame, navigation arrows or counter, while view mode shows a slide-show showing one image at a time. For example, the Usage example of the documentation, with two existing images, one per line, shows both images in the editor and a black 620 px slide-show showing "1 / 2" in view mode. |
| E2 errors | KO | invalid values are accepted silently, with no message. For example, {{gallery width="abc"}}image:[email protected]{{/gallery}} renders with style="width: abc;", and {{gallery height="300"}}image:[email protected]{{/gallery}} with style="height: 300;", which browsers ignore, so the gallery keeps its default size. A reference to a missing image, like image:alice.png , shows an endless loading spinner in the slide-show. |
| E3 nesting | KO | in a list item and in a table cell, like * {{gallery}}image:[email protected]{{/gallery}} , the gallery is inline and renders "The [gallery] macro is a standalone macro and it cannot be used inline." in the editor and in view mode; it works only when wrapped in a group, * ((( {{gallery}}...{{/gallery}} ))) , which the editor does not create. In a box it works. A list, a table or a box in its content, like {{gallery}}* one{{/gallery}} , is shown in the editor but silently dropped in view mode, which shows an empty "0 / 0" slide-show. |
| E4 inline-support | OK | the macro declares no inline support, and its output is a block slide-show with a fixed size, which cannot be inside a sentence. |
| E5 empty | OK | the content is never edited in place, so it cannot be emptied in the editor. A gallery with an empty content, {{gallery/}} , keeps the visible "macro:gallery" placeholder, which one click selects; its content is edited through the dialog, counted under E6. |
| E6 inplace | KO | the content is a plain text of wiki syntax, not rich text, and is edited only in a text area of the Edit Macro dialog: the editor shows the images, but they cannot be added, removed or reordered in place, and adding an image means typing its reference in wiki syntax, like image:[email protected] . |
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 | KO | OK | N/A | OK | N/A | OK | N/A | N/A | N/A | N/A | C1: the description asks for images "specified using the syntax of the current page", with an example for "XWiki 2.0 syntax": technical terms, and an outdated syntax version. It does not say that anything other than images, like text or a list, is dropped. C4: a plain text area of wiki syntax in the Edit Macro dialog, counted under E6. |
| class | KO | OK | OK | OK | OK | OK | N/A | KO | OK | N/A | C1: the name is the parameter ID, "Class", in every language, and French and German show the English description "Custom CSS class names to set on the gallery container". C8: a styling parameter that is rarely used, and no common example sets it, but it is not marked as advanced. |
| height | KO | OK | OK | OK | OK | OK | N/A | OK | OK | KO | C1: the description "The gallery height" repeats the name and does not say what value is expected, a CSS length like 349px, nor that an empty value keeps the default height of 349px. The name is the parameter ID in every language, and French and German show the English description. C3: the field opens empty, which gives the default height of 349px of the gallery stylesheet, the value of the most common example; the default is not declared nor shown. C13: only accepts a CSS length, but declares no format: "abc" is accepted by the dialog and output as style="height: abc;", and "300" without a unit as style="height: 300;". |
| width | KO | OK | OK | OK | OK | OK | N/A | OK | OK | KO | C1: the description "The gallery width" repeats the name and does not say what value is expected, a CSS length like 620px or 100%, nor that an empty value keeps the default width of 620px. The name is the parameter ID in every language, and French and German show the English description. C3: the field opens empty, which gives the default width of 620px of the gallery stylesheet, the value of the most common example; the default is not declared nor shown. C13: only accepts a CSS length, 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 | |
| L1 | L1 consistency | XWIKI-25506 | |
| L2 | L2 doc-parameters | XINFRA-525 | |
| I1 | I1 pattern | XWIKI-25563 | |
| I3 | I3 instant | XWIKI-16308, XWIKI-23735 | XWIKI-25563 |
| I4 | I4 cursor | XWIKI-25569 | |
| E1 | E1 wysiwyg | XWIKI-25523 (partial), XWIKI-25524 | |
| E2 | E2 errors | XCOMMONS-3847 (partial), XRENDERING-823 (partial), XWIKI-25508 (partial), XWIKI-25582 (partial) | |
| E3 | E3 nesting | XWIKI-23501 | XWIKI-25560 |
| E6 | E6 inplace | XWIKI-23735 (partial) | XWIKI-25571 |
| C1:$content | C1 clarity, $content | XWIKI-25481 | |
| C1:class | C1 clarity, class | XWIKI-25481 | |
| C8:class | C8 advanced, class | XWIKI-25482 | |
| C1:height | C1 clarity, height | XWIKI-25481 | |
| C13:height | C13 constraints, height | XWIKI-25508 | |
| C1:width | C1 clarity, width | XWIKI-25481 | |
| C13:width | C13 constraints, width | XWIKI-25508 |
Tickets
| Ticket | Origin | KOs covered | KOs partly covered |
|---|---|---|---|
| XWIKI-16308 | Existing | I3 | |
| XWIKI-23501 | Existing | E3 | |
| XWIKI-23735 | Existing | I3 | E6 |
| XCOMMONS-3847 | New | E2 | |
| XRENDERING-823 | New | E2 | |
| XWIKI-25444 | New | D4 | |
| XWIKI-25481 | New | C1:$content C1:class C1:height C1:width | |
| XWIKI-25482 | New | C8:class | |
| XWIKI-25506 | New | L1 | |
| XINFRA-525 | New | L2 | |
| XWIKI-25508 | New | C13:height C13:width | E2 |
| XWIKI-25523 | New | E1 | |
| XWIKI-25524 | New | E1 | |
| XWIKI-25560 | New | E3 | |
| XWIKI-25563 | New | I1 I3 | |
| XWIKI-25569 | New | I4 | |
| XWIKI-25571 | New | E6 | |
| XWIKI-25582 | New | E2 |
Known issues of this macro
| Issue | Title | Status | Criteria |
|---|---|---|---|
| XWIKI-23735 | Provide an image picker for the Gallery macro when used in WYSIWYG | Open | C4 |
68 more known issues affect every macro: see the Known issues.
