| 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/Wiki%20Application#H22Wikis22Macro |
| 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 | Not recorded yet: search GitHub |
| 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 | children, documentTree |
| Criterion | Result | Notes |
|---|
| D1 wording | OK | the name "Wikis" is the word a user would use for the list of wikis it produces, with no code identifier or acronym. |
| D2 summary | KO | the description "List all wikis" repeats the name. It is also inaccurate: the output only lists the wikis the current user can view, and adds a "Create a new wiki" link when the user may create one, as the documentation says: "It only lists the wikis that the user can access". It could say "Lists the wikis you can access, with a link to create a new one." |
| D3 category | OK | the macro is in Navigation, the category of the compared macros children and documentTree. |
| D4 quick-action | KO | Quick Actions finds the macro first for "wikis" and "Wikis". The French and German names are the English name "Wikis", which is the common word in those languages, so they are not counted against it. The synonyms "workspaces", "wiki list", "list wikis", "subwikis" and "farm" give no result, in Quick Actions and in the Insert Macro dialog. Recorded as KO, like children, until the synonyms to support are decided. |
| L1 consistency | OK | compared with children and documentTree: like them, no parameter is mandatory, there is no content, and the Quick Action inserts the macro right away. Unlike them, the macro has no parameter at all, so the Edit Macro dialog only says "This macro has no parameters.", which is by design. |
| L2 doc-parameters | OK | the macro has no parameter, and the documentation says so: "There is no parameter." |
| L3 doc-example | OK | the documentation shows {{wikis/}} , the only call of the macro, and it renders without error. |
| I1 pattern | OK | the Quick Action inserts {{wikis/}} right away, with no dialog, and the Insert Macro dialog opens the Edit Macro dialog with no field, the same steps as children and documentTree. |
| I2 zero-config | OK | inserting with the defaults gives the list of the wikis the user can view, with no error in the editor or in view mode. |
| I3 instant | N/A |
|
| I4 cursor | N/A |
|
| I5 focus | OK | the macro has no parameter, so no mandatory parameter is hidden below the fold. |
| E1 wysiwyg | OK | the editor shows the same list as view mode, "Home" and "Create a new wiki", with no placeholder, because the output is plain server-side HTML that needs no JavaScript. |
| E2 errors | N/A | the macro has no parameter, so there is no value to invalidate. An unknown parameter, {{wikis noSuchParameter="x"/}} , is accepted silently, which is generic for every macro and not recorded here. |
| E3 nesting | KO | in a list item and in a table cell the macro renders the standalone error "The [wikis] macro is a standalone macro and it cannot be used inline. Click on this message for details." in view mode and in the editor. In a box it works. The macro has no content, so the second half of the measure does not apply. |
| E4 inline-support | OK | the macro declares no inline support, and its output is a list, a block element that cannot be inside a sentence, which is a technical reason. |
| E5 empty | N/A | the macro has no content. |
| E6 inplace | N/A | the macro has no content. |
Lucas Charpentier
