Documentation status

Last modified by Lucas Charpentier on 2026/10/13 15:07

This page tracks, as of 2026-09-23, where each of the 68 macros analysed in this proposal is documented, and whether that documentation has been migrated to the new documentation tree on xwiki.org.

Summary

  • 12 macros have a Reference page in the new documentation tree.
  • 47 macros are still documented only in the legacy documentation, mostly on extensions.xwiki.org.
  • 9 macros have no documentation at all.

Beyond the migration itself, a recurring problem shows in the table: 13 macros have no page of their own and are only covered by a section of the page of the application that ships them, which makes them hard to find and impossible to link to precisely.

Status per macro

MacroStatusNew documentationLegacy documentationNotes
asyncMigrated"async" MacroAsync Macro
attachmentGalleryPickerMigrated"attachmentGalleryPicker" MacroAttachment > Picker > Macro
attachmentSelectorMigrated"attachmentSelector" MacroAttachment ApplicationSection of a larger page.
boxMigrated"box" MacroBox Macro
cacheLegacy only-Cache Macro
chartLegacy only-Chart Macro
chartjsLegacy only-Chart.js IntegrationSection of a larger page.
childrenLegacy only-Children Macro
codeLegacy only-Code Macro
commentLegacy only-Comment Macro
containerLegacy only-Container Macro
contentLegacy only-Content Macro
contextLegacy only-Context Macro
dashboardLegacy only-Dashboard Macro
displayMigrated"display" MacroDisplay Macro
displayIconMigratedThe displayIcon MacroIcon Macro
documentsLegacy only-Documents Macro
documentTreeLegacy only-Document Tree Macro
errorMigrated"error" MacroError Macro
exampleUndocumented-NoneNo page found: the Help Application page does not mention it.
faqLegacy only-FAQ ApplicationSection of a larger page.
figureLegacy only-Figure > Figure Macro
figureCaptionLegacy only-Figure > Figure MacroSection of a larger page.
figureTypeRecognizerLegacy only-Figure > Figure MacroSection of a larger page.
footnoteLegacy only-Footnote Macro
galleryLegacy only-Gallery Macro
gdprSettingsLegacy only-GDPR Cookie Consent (store.xwiki.com)
groovyLegacy only-Groovy Macro
htmlLegacy only-HTML Macro
iconPickerLegacy only-Icon Theme ApplicationSection of a larger page.
idLegacy only-Id Macro
includeLegacy only-Include Macro
infoMigrated"info" MacroInfo Macro
jiraMigrated"jira" MacroJIRA > JIRA Macro
jwplayerLegacy only-JW Player Macro
liveDataMigrated"liveData" MacroLive Data Macro
mathjaxLegacy only-MathJax > MathJaxMacro
mentionLegacy only-Mentions ApplicationSection of a larger page.
menuLegacy only-Menu ApplicationSection of a larger page.
notificationsLegacy only-Notifications Macro
notificationsApplicationsPreferencesUndocumented-NoneAdmin macro, no page found.
notificationsAutoWatchPreferencesUndocumented-NoneAdmin macro, no page found.
notificationsCustomFiltersPreferencesUndocumented-NoneAdmin macro, no page found.
notificationsEmailPreferencesUndocumented-NoneAdmin macro, no page found.
notificationsFiltersPreferencesUndocumented-NoneAdmin macro, no page found.
notificationsSystemFiltersPreferencesUndocumented-NoneAdmin macro, no page found.
officeUndocumented-NoneNot analysed, no page found.
pdftocUndocumented-NoneOnly the Java source documents it: not on extensions.xwiki.org.
plantumlLegacy only-PlantUML Macro
putFootnotesLegacy only-Footnote MacroSection of a larger page.
pythonLegacy only-Python Macro
referenceLegacy only-Numbered Content > Reference > Macro
scriptLegacy only-Script Macro
successMigrated"success" MacroSuccess Macro
tableToChartJSLegacy only-Chart.js IntegrationSection of a larger page.
tagcloudLegacy only-Tag Cloud Macro
templateLegacy only-Template Macro
tocLegacy only-TOC Macro
translationLegacy only-Translation Macro
treeLegacy only-Tree Macro
uiextensionLegacy only-Extension Module > UI Extension Macro
uiextensionsLegacy only-Extension Module > UI Extensions Macro
useravatarLegacy only-User Avatar Macro
velocityLegacy only-Velocity Macro
warningMigrated"warning" MacroWarning Macro
wikimacrocontentLegacy only-Wiki Macro TutorialSection of a larger page.
wikimacroparameterLegacy only-Wiki Macro TutorialSection of a larger page.
wikisLegacy only-Wiki ApplicationSection of a larger page.

Conventions

A macro counts as Migrated when a page built on the DocApp.Code.RenderingMacroClass template exists for it under documentation. The list of those pages comes from the Solr query class:"DocApp.Code.RenderingMacroClass", so this table can be refreshed by re-running it.

The migration conventions themselves, from the page template to the parameter table columns and the naming and placement rules, are discussed in the forum thread Consistency of the macro parameter table.

Get Connected