Per macro analysis

Last modified by Lucas Charpentier on 2026/09/18 14:28

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.

For the conclusions drawn from these pages, see Cross-macro findings.

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 emoticon_smile

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.

Id of the macroFrom projectMacro doc URL
asyncXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Async%20Macro/
attachmentGalleryPickerXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Attachment/Picker/Macro/
attachmentSelectorXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Attachment%20Application#HAttachmentSelector
boxXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Box%20Macro#HDescription
cacheXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Cache%20Macro
chartXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Chart%20Macro#HUsage
chartjsChart.js Integrationhttps://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HChartJSMacro
childrenXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Children%20Macro/
codeXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro/
commentXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Comment%20Macro
containerXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Container%20Macro
contentXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Content%20Macro#HUsage
contextXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Context%20Macro#HUsage
dashboardXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Dashboard%20Macro#HDescription
displayXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Display%20Macro#HFromWikiSyntax    
displayIconXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Macro/#HFromWikiSyntax
documentsXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Documents%20Macro#HDescription
documentTreeXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Document%20Tree%20Macro#HWikiMacro
errorXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Error%20Macro#HUsage
exampleXS

NAN, no doc? https://www.xwiki.org/xwiki/bin/view/Help/Code/ExampleMacro#Information  

or https://extensions.xwiki.org/xwiki/bin/view/Extension/Help%20Application#HAvailableMacros 

which doesn't contain any reference to it...

No backlinks on https://dev.xwiki.org/xwiki/bin/view/Help/Code/ExampleMacro#Information  either.

This macro is fairly difficult to find info about so I guess noone knows about it and barely noone uses it.

faqFAQ Applicationhttps://extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application#HFAQMacro
figureFigure Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage
figureCaptionFigure Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage
figureTypeRecognizerFigure Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HFigureTypeIdentification (internal macro)
footnoteXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage
galleryXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery%20Macro#HUsage
gdprSettingsGDPR Cookie Consenthttps://store.xwiki.com/xwiki/bin/view/Extension/GDPRCookieConsent/#documentation store page only but LGPL 2.1 and no licences
groovyXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Groovy%20Macro#HUsage
htmlXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/HTML%20Macro#HUsage
iconPickerXS
idXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Id%20Macro#HUsage
includeXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Include%20Macro#HUsage
infoXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Info%20Macro#HUsage
jiraJIRA Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/JIRA/JIRA%20Macro#HUsage
jwplayerJW Player Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro#HUsage
liveDataXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Live%20Data%20Macro/#HUsage
mathjaxMathjax Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/MathJax/MathJaxMacro/#HUsage
mentionXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Mentions%20Application/#HUsingtheSourceEditor
menuXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Menu%20Application#HUsage
notificationsXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Notifications%20Macro/#HUsage
notificationsApplicationsPreferencesXS? Mostly internal
notificationsAutoWatchPreferencesXS? Mostly internal
notificationsCustomFiltersPreferencesXS? Mostly internal
notificationsEmailPreferencesXS? Mostly internal
notificationsFiltersPreferencesXS? Mostly internal
notificationsSystemFiltersPreferencesXS? Mostly internal
officeXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro#HUsage
pdftocXShttps://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/
plantumlPlantUML Macrohttps://extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML%20Macro#HUsage
putFootnotesXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage-1
pythonXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Python%20Macro#HUsage
referenceReference Macro for the Numbered Content Applicationshttps://extensions.xwiki.org/xwiki/bin/view/Extension/Numbered%20Content/Reference/Macro/#HDescription
scriptXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Script%20Macro#HUsage
successXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Success%20Macro#HUsage
tableToChartJSChart.js Integrationhttps://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HUsage-1
tagcloudXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Tag%20Cloud%20Macro#HUsage
templateXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Template%20Macro#HDescription
tocXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/TOC%20Macro#HFromWikiSyntax
translationXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Translation%20Macro#HUsage
treeXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Tree%20Macro#HWikiMacro
uiextensionXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extension%20Macro/#HUsage
uiextensionsXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extensions%20Macro/#HUsage
useravatarXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/User%20Avatar%20Macro#HUsage
velocityXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20Macro#HUsage
warningXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Warning%20Macro#HUsage
wikimacrocontentXShttps://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/#HContentXShttps://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/#HParametersXShttps://extensions.xwiki.org/xwiki/bin/view/Extension/Wiki%20Application#H22Wikis22Macro

Get Connected