| Source | What it gives | Used for | Where |
|---|
| Documentation | Parameters, default values and examples, including the most common example | L2, L3, and the criteria measured with the most common example | https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage |
| Source code | How the macro declares its parameters and content: types, groups, features, advanced and hidden flags, constraints, content type, inline support | C4, C5, C7, C8, C9, C13, E4, E6 | https://github.com/xwiki/xwiki-rendering/blob/xwiki-rendering-18.8.0/xwiki-rendering-macros/xwiki-rendering-macro-footnotes/src/main/java/org/xwiki/rendering/internal/macro/footnote/FootnoteMacro.java |
| Macro descriptor | What the Edit Macro dialog is built from, on design.xwiki.org | D1, D2, C1 to C9, E4 | Descriptor, list of macros with their categories |
| Translations | The name, description and parameter names in each language | D1, D2, D4, C1 | l10n.xwiki.org |
| Uses in XWiki pages | How XWiki itself uses the macro, a realistic example when the documentation has none | L3, C2, C3, C6, C8, C9 | Search the xwiki organization on GitHub |
| Compared macros | The audits of the macros of the same type | L1, D3 | comment, box |
| Criterion | Result | Notes |
|---|
| D1 wording | OK |
|
| D2 summary | KO | minor: "Generates a footnote to display at the end of the page." repeats the name and only adds where the note goes. It does not say what the reader sees where the macro is inserted, a superscript number linking to the note, nor that the notes are listed at the end of the page, or where a {{putFootnotes/}} macro is placed. |
| D3 category | OK |
|
| D4 quick-action | KO | Quick Actions finds the macro first for "footnote", for the French name "Note de bas de page", and second for the synonym "note". The synonyms "endnote", "citation" and "reference" give no result. |
| L1 consistency | OK | compared with comment and box. Like comment, the content is mandatory with no default, the Quick Action opens the Edit Macro dialog and the content is typed in its text area. Box has an optional content and is inserted directly, but an empty footnote gives no sensible result, so the mandatory content is by design. |
| L2 doc-parameters | KO | the macro is documented only on the legacy extensions.xwiki.org page, with no page in the new documentation. That page describes the content as "text" in a "Parameters definition" list and does not say that it is mandatory. |
| L3 doc-example | OK |
|
| I1 pattern | KO | the reference wrapper, warning, is inserted by its Quick Action without a dialog; the footnote Quick Action opens the Edit Macro dialog, see I3, the generic behavior of macros without a dedicated Quick Action. Inserting the macro also adds a {{putFootnotes/}} macro at the end of the page source, silently, with no notice in the editor or the Edit Macro dialog explaining why: typing " /footnote", Enter, "My note" and submitting in a page holding "A sentence" saves A sentence {{footnote}}My note{{/footnote}} followed by a {{putFootnotes/}} paragraph. |
| 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. {{footnote/}} renders with no error, as a number and an empty note. |
| I3 instant | KO | inserting from the Quick Actions menu with "/footnote" and Enter opens the Edit Macro dialog with an empty Content text area; the macro is only inserted after typing a text and submitting. |
| I4 cursor | KO | after submitting the dialog, the macro widget is selected and the cursor is not in its content. Text typed right away goes before the footnote number, not after it: inserting a footnote at the end of "A sentence" then typing "XYZ" gives A sentence XYZ{{footnote}}My note{{/footnote}} . |
| I5 focus | N/A |
|
| E1 wysiwyg | OK | the editor shows the footnote number and the list of notes at the end of the page, like view mode. |
| E2 errors | N/A | the macro has no parameter and accepts any text as content, so there is no invalid value to test. |
| E3 nesting | OK | the footnote renders in a list item, a table cell and a box, and a list, a table and a box render inside its content, the box as an inline box. Its content is edited through the dialog everywhere, as at the top level, see E6. |
| E4 inline-support | OK |
|
| E5 empty | KO | minor: the empty macro keeps a visible footnote number, but it is a click target of about 6 by 20 pixels, below the 24 pixels of WCAG 2.5.8. Its content is edited through the dialog, counted under E6. |
| E6 inplace | KO | the content is wiki syntax, rendered with its formatting, like Text{{footnote}}**bold** [[link>>https://xwiki.org]]{{/footnote}}. , but it is declared as a plain string, so it is never edited in place: changing a footnote needs opening the Edit Macro dialog, where it is a plain text area of wiki syntax. |
Lucas Charpentier
