Wiki source code of Per macro analysis
Last modified by Lucas Charpentier on 2026/09/18 14:28
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | This is the detailed analysis of each macro. Each page holds the parameters of the macro, how its edit dialog is opened, the screenshots of the dialogs, the problems found, and the JIRA issues that cover them. | ||
| 2 | |||
| 3 | For the conclusions drawn from these pages, see [[Cross-macro findings>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Cross-macro findings.WebHome]]. | ||
| 4 | |||
| 5 | Note that I've done most of the screenshots on a 2K screen. For the sake of brevity, when the extended dialog was over the size of the screen (and needed scrolling to see everything), I only provided what can be seen on my display without any scrolling or zooming. Note that in most use cases, users won't even be able to see that much at first :) | ||
| 6 | |||
| 7 | When looking for existing jira issues, I filtered on only open issues, related to the macro usability in CKEditor and in the xwiki-platform, xwiki-rendering or their extension's projects. In order to find the issues to go through, I'd either string search its id, or select its component if there's one. | ||
| 8 | |||
| 9 | |=Id of the macro|=From project|=Macro doc URL | ||
| 10 | |[[async>>doc:.async.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Async%20Macro/>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Async%20Macro/]] | ||
| 11 | |[[attachmentGalleryPicker>>doc:.attachmentGalleryPicker.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Attachment/Picker/Macro/>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Attachment/Picker/Macro/]] | ||
| 12 | |[[attachmentSelector>>doc:.attachmentSelector.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Attachment%20Application#HAttachmentSelector>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Attachment%20Application#HAttachmentSelector]] | ||
| 13 | |[[box>>doc:.box.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Box%20Macro#HDescription>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Box%20Macro#HDescription]] | ||
| 14 | |[[cache>>doc:.cache.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Cache%20Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Cache%20Macro]] | ||
| 15 | |[[chart>>doc:.chart.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Chart%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart%20Macro#HUsage]] | ||
| 16 | |[[chartjs>>doc:.chartjs.WebHome]]|Chart.js Integration|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HChartJSMacro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HChartJSMacro]] | ||
| 17 | |[[children>>doc:.children.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Children%20Macro/>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Children%20Macro/]] | ||
| 18 | |[[code>>doc:.code.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro/>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro/]] | ||
| 19 | |[[comment>>doc:.comment.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Comment%20Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Comment%20Macro]] | ||
| 20 | |[[container>>doc:.container.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Container%20Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Container%20Macro]] | ||
| 21 | |[[content>>doc:.content.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Content%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Content%20Macro#HUsage]] | ||
| 22 | |[[context>>doc:.context.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Context%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Context%20Macro#HUsage]] | ||
| 23 | |[[dashboard>>doc:.dashboard.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Dashboard%20Macro#HDescription>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Dashboard%20Macro#HDescription]] | ||
| 24 | |[[display>>doc:.display.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Display%20Macro#HFromWikiSyntax >>https://extensions.xwiki.org/xwiki/bin/view/Extension/Display%20Macro#HFromWikiSyntax]] | ||
| 25 | |[[displayIcon>>doc:.displayIcon.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Macro/#HFromWikiSyntax>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Macro/#HFromWikiSyntax]] | ||
| 26 | |[[documents>>doc:.documents.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Documents%20Macro#HDescription>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Documents%20Macro#HDescription]] | ||
| 27 | |[[documentTree>>doc:.documentTree.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Document%20Tree%20Macro#HWikiMacro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Document%20Tree%20Macro#HWikiMacro]] | ||
| 28 | |[[error>>doc:.error.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Error%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Error%20Macro#HUsage]] | ||
| 29 | |[[example>>doc:.example.WebHome]]|XS|((( | ||
| 30 | NAN, no doc? [[https:~~/~~/www.xwiki.org/xwiki/bin/view/Help/Code/ExampleMacro#Information >>xwiki:Help.Code.ExampleMacro||anchor="Information"]] | ||
| 31 | |||
| 32 | or [[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Help%20Application#HAvailableMacros >>https://extensions.xwiki.org/xwiki/bin/view/Extension/Help%20Application#HAvailableMacros]] | ||
| 33 | |||
| 34 | which doesn't contain any reference to it... | ||
| 35 | |||
| 36 | No backlinks on [[https:~~/~~/dev.xwiki.org/xwiki/bin/view/Help/Code/ExampleMacro#Information >>https://dev.xwiki.org/xwiki/bin/view/Help/Code/ExampleMacro#Information]]either. | ||
| 37 | |||
| 38 | This macro is fairly difficult to find info about so I guess noone knows about it and barely noone uses it. | ||
| 39 | ))) | ||
| 40 | |[[faq>>doc:.faq.WebHome]]|FAQ Application|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application#HFAQMacro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application#HFAQMacro]] | ||
| 41 | |[[figure>>doc:.figure.WebHome]]|Figure Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage]] | ||
| 42 | |[[figureCaption>>doc:.figureCaption.WebHome]]|Figure Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage]] | ||
| 43 | |[[figureTypeRecognizer>>doc:.figureTypeRecognizer.WebHome]]|Figure Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HFigureTypeIdentification>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HFigureTypeIdentification]] (internal macro) | ||
| 44 | |[[footnote>>doc:.footnote.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage]] | ||
| 45 | |[[gallery>>doc:.gallery.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Gallery%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery%20Macro#HUsage]] | ||
| 46 | |[[gdprSettings>>doc:.gdprSettings.WebHome]]|GDPR Cookie Consent|[[https:~~/~~/store.xwiki.com/xwiki/bin/view/Extension/GDPRCookieConsent/#documentation >>https://store.xwiki.com/xwiki/bin/view/Extension/GDPRCookieConsent/#documentation]]store page only but LGPL 2.1 and no licences | ||
| 47 | |[[groovy>>doc:.groovy.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Groovy%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Groovy%20Macro#HUsage]] | ||
| 48 | |[[html>>doc:.html.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/HTML%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/HTML%20Macro#HUsage]] | ||
| 49 | |[[iconPicker>>doc:.iconPicker.WebHome]]|XS|((( | ||
| 50 | [[https:~~/~~/www.xwiki.org/xwiki/bin/view/IconThemesCode/IconPickerMacro>>xwiki:IconThemesCode.IconPickerMacro]] | ||
| 51 | |||
| 52 | [[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Theme%20Application#HIconPickerMacro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Theme%20Application#HIconPickerMacro]] | ||
| 53 | ))) | ||
| 54 | |[[id>>doc:.id.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Id%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Id%20Macro#HUsage]] | ||
| 55 | |[[include>>doc:.include.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Include%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Include%20Macro#HUsage]] | ||
| 56 | |[[info>>doc:.info.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Info%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Info%20Macro#HUsage]] | ||
| 57 | |[[jira>>doc:.jira.WebHome]]|JIRA Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/JIRA/JIRA%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/JIRA/JIRA%20Macro#HUsage]] | ||
| 58 | |[[jwplayer>>doc:.jwplayer.WebHome]]|JW Player Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro#HUsage]] | ||
| 59 | |[[liveData>>doc:.liveData.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Live%20Data%20Macro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Live%20Data%20Macro/#HUsage]] | ||
| 60 | |[[mathjax>>doc:.mathjax.WebHome]]|Mathjax Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/MathJax/MathJaxMacro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/MathJax/MathJaxMacro/#HUsage]] | ||
| 61 | |[[mention>>doc:.mention.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Mentions%20Application/#HUsingtheSourceEditor>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Mentions%20Application/#HUsingtheSourceEditor]] | ||
| 62 | |[[menu>>doc:.menu.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Menu%20Application#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Menu%20Application#HUsage]] | ||
| 63 | |[[notifications>>doc:.notifications.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Notifications%20Macro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Notifications%20Macro/#HUsage]] | ||
| 64 | |[[notificationsApplicationsPreferences>>doc:.notificationsApplicationsPreferences.WebHome]]|XS|? Mostly internal | ||
| 65 | |[[notificationsAutoWatchPreferences>>doc:.notificationsAutoWatchPreferences.WebHome]]|XS|? Mostly internal | ||
| 66 | |[[notificationsCustomFiltersPreferences>>doc:.notificationsCustomFiltersPreferences.WebHome]]|XS|? Mostly internal | ||
| 67 | |[[notificationsEmailPreferences>>doc:.notificationsEmailPreferences.WebHome]]|XS|? Mostly internal | ||
| 68 | |[[notificationsFiltersPreferences>>doc:.notificationsFiltersPreferences.WebHome]]|XS|? Mostly internal | ||
| 69 | |[[notificationsSystemFiltersPreferences>>doc:.notificationsSystemFiltersPreferences.WebHome]]|XS|? Mostly internal | ||
| 70 | |[[office>>doc:.office.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro#HUsage]] | ||
| 71 | |[[pdftoc>>doc:.pdftoc.WebHome]]|XS|[[https:~~/~~/github.com/xwiki/xwiki-platform/blob/769f06f65aaaa57b6614a818414629a0f35a64cf/xwiki-platform-core/xwiki-platform-export/xwiki-platform-export-pdf/xwiki-platform-export-pdf-api/src/main/java/org/xwiki/export/pdf/internal/macro/PDFTocMacro.java#L61>>https://github.com/xwiki/xwiki-platform/blob/769f06f65aaaa57b6614a818414629a0f35a64cf/xwiki-platform-core/xwiki-platform-export/xwiki-platform-export-pdf/xwiki-platform-export-pdf-api/src/main/java/org/xwiki/export/pdf/internal/macro/PDFTocMacro.java#L61]] Internal? Not documented on [[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/PDF%20Export%20Application/>>https://extensions.xwiki.org/xwiki/bin/view/Extension/PDF%20Export%20Application/]] | ||
| 72 | |[[plantuml>>doc:.plantuml.WebHome]]|PlantUML Macro|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML%20Macro#HUsage]] | ||
| 73 | |[[putFootnotes>>doc:.putFootnotes.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage-1>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage-1]] | ||
| 74 | |[[python>>doc:.python.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Python%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Python%20Macro#HUsage]] | ||
| 75 | |[[reference>>doc:.reference.WebHome]]|Reference Macro for the Numbered Content Applications|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Numbered%20Content/Reference/Macro/#HDescription>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Numbered%20Content/Reference/Macro/#HDescription]] | ||
| 76 | |[[script>>doc:.script.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Script%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Script%20Macro#HUsage]] | ||
| 77 | |[[success>>doc:.success.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Success%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Success%20Macro#HUsage]] | ||
| 78 | |[[tableToChartJS>>doc:.tableToChartJS.WebHome]]|Chart.js Integration|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HUsage-1>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HUsage-1]] | ||
| 79 | |[[tagcloud>>doc:.tagcloud.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Tag%20Cloud%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Tag%20Cloud%20Macro#HUsage]] | ||
| 80 | |[[template>>doc:.template.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Template%20Macro#HDescription>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Template%20Macro#HDescription]] | ||
| 81 | |[[toc>>doc:.toc.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/TOC%20Macro#HFromWikiSyntax>>https://extensions.xwiki.org/xwiki/bin/view/Extension/TOC%20Macro#HFromWikiSyntax]] | ||
| 82 | |[[translation>>doc:.translation.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Translation%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Translation%20Macro#HUsage]] | ||
| 83 | |[[tree>>doc:.tree.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Tree%20Macro#HWikiMacro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Tree%20Macro#HWikiMacro]] | ||
| 84 | |[[uiextension>>doc:.uiextension.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extension%20Macro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extension%20Macro/#HUsage]] | ||
| 85 | |[[uiextensions>>doc:.uiextensions.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extensions%20Macro/#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extensions%20Macro/#HUsage]] | ||
| 86 | |[[useravatar>>doc:.useravatar.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/User%20Avatar%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/User%20Avatar%20Macro#HUsage]] | ||
| 87 | |[[velocity>>doc:.velocity.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20Macro#HUsage]] | ||
| 88 | |[[warning>>doc:.warning.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Warning%20Macro#HUsage>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Warning%20Macro#HUsage]] | ||
| 89 | |[[wikimacrocontent>>doc:.wikimacrocontent.WebHome]]|XS|[[https:~~/~~/www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/#HContent>>xwiki:Documentation.DevGuide.Tutorials.WritingMacros.WikiMacroTutorial.WebHome | ||
| 90 | |[[wikimacroparameter>>doc:.wikimacroparameter.WebHome]]|XS|[[https:~~/~~/www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/#HParameters>>xwiki:Documentation.DevGuide.Tutorials.WritingMacros.WikiMacroTutorial.WebHome | ||
| 91 | |[[wikis>>doc:.wikis.WebHome]]|XS|[[https:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/Wiki%20Application#H22Wikis22Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Wiki%20Application#H22Wikis22Macro]] |
