Wiki source code of Documentation status
Last modified by Lucas Charpentier on 2026/10/27 10:30
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This page tracks the progress on the documentation and consistency criteria of the macros, then, 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>>https://www.xwiki.org/xwiki/bin/view/documentation/]] on xwiki.org. | ||
| 6 | |||
| 7 | == Documentation and consistency criteria == | ||
| 8 | |||
| 9 | The KOs of the criteria L1, L2 and L3 of the [[Triage>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Triage.WebHome]] are not reported macro by macro: L2 and L3 are each tracked by one generic JIRA issue, and L1 by one issue per macro; the tables below show their progress. When a fix is done, set the status of its row to (% class="label label-warning" %)In progress(%%) or (% class="label label-success" %)Fixed(%%) and link the documentation page, the pull request or the ticket in the Fix column. A row is (% class="label label-info" %)Other ticket(%%) when a ticket of another criterion makes the KO moot, like a macro moving to the Internal category, whose documentation is then not needed. | ||
| 10 | |||
| 11 | The documentation column says where the macro is documented at the time of the audit, see the [[Status per macro>>||anchor="HStatuspermacro"]] section below for the migration of each macro. "Minor" marks the KOs recorded as minor in the audit. | ||
| 12 | |||
| 13 | === L1 consistency === | ||
| 14 | |||
| 15 | JIRA issues: one per macro, in the Fix column. 2 KOs, as of 22 October 2026. | ||
| 16 | |||
| 17 | |=Macro|=Status|=Documentation|=Problem|=Fix | ||
| 18 | |[[gallery>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.gallery.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery%20Macro#HUsage]]|Its mandatory content uses a format of its own, a plain text list of images, so its Quick Action opens the Edit Macro dialog, unlike figure and container.|[[XWIKI-25506>>https://jira.xwiki.org/browse/XWIKI-25506]] | ||
| 19 | |[[office>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.office.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro]]|It declares no mandatory parameter, unlike include and display, so its Quick Action inserts an empty call that renders an error box.|[[XWIKI-25507>>https://jira.xwiki.org/browse/XWIKI-25507]] | ||
| 20 | |||
| 21 | === L2 doc-parameters === | ||
| 22 | |||
| 23 | JIRA issue: [[XINFRA-525>>https://jira.xwiki.org/browse/XINFRA-525]]. 51 KOs, as of 22 October 2026. Unless the Problem column says otherwise, the parameters are only documented on a legacy extensions.xwiki.org page, with no page in the new documentation tree: the fix is the migration of that page, checked against the macro descriptor. | ||
| 24 | |||
| 25 | |=Macro|=Status|=Documentation|=Problem|=Fix | ||
| 26 | |[[activity>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.activity.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Activity%20Macro]]|Documents a "subentries" parameter that does not exist. The defaults of wikis, spaces and authors are only in the text.|- | ||
| 27 | |[[cache>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.cache.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Cache%20Macro]]|No new page, unlike async. The content is not listed, and the page gives id a default that the descriptor leaves empty.|- | ||
| 28 | |[[chart>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.chart.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart%20Macro#HUsage]]|Lists colors as a parameter while it is a key of params. Documents width and height as strings instead of integers. The content is not in the table.|- | ||
| 29 | |[[chartjs>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.chartjs.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HChartJSMacro]]|The mandatory content is not in the table. The type list misses horizontalBar. Width and height only exist as keys of options.|- | ||
| 30 | |[[children>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.children.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Children%20Macro/]]|Documents the "name" sort, which the Sort by select does not offer.|- | ||
| 31 | |[[code>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.code.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro/]]|Documents only language, layout and source, and covers the box parameters with a reference to the Box Macro page.|- | ||
| 32 | |[[comment>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.comment.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Comment%20Macro]]|Minor. Says "No parameters." and does not describe the mandatory content.|- | ||
| 33 | |[[container>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.container.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Container%20Macro]]|cssClass and the content are not documented.|- | ||
| 34 | |[[content>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.content.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Content%20Macro#HUsage]]|Gives syntax as mandatory, while it defaults to the current syntax since XWiki 15.1. The content is not documented.|- | ||
| 35 | |[[context>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.context.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Context%20Macro#HUsage]]|The parameters are a list with no table. The content is not mentioned, and the default of transformationContext is not stated.|- | ||
| 36 | |[[dashboard>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.dashboard.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Dashboard%20Macro#HDescription]]|Gives "none" as the default of layout, while the macro declares columns.|- | ||
| 37 | |[[documents>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.documents.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Documents%20Macro#HDescription]]|The description parameter is not documented. Documents space and parent as deprecated parameters the macro does not declare.|- | ||
| 38 | |[[documentTree>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.documentTree.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Document%20Tree%20Macro#HWikiMacro]]|Documents showChildDocuments, which was removed, and gives sortDocumentsBy a title:asc default the macro does not declare.|- | ||
| 39 | |[[example>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.example.WebHome]]|(% class="label label-info" %)Other ticket|(% class="label label-danger" %)None|No documentation at all.|[[XWIKI-25018>>https://jira.xwiki.org/browse/XWIKI-25018]]: the macro becomes internal. | ||
| 40 | |[[faq>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.faq.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application#HFAQMacro]]|Section of the FAQ Application page. filter is described in one sentence, with no table, and its keys only appear in the examples.|- | ||
| 41 | |[[figure>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.figure.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage]]|The table lists only type. The content and its optional flag are only shown in the examples.|- | ||
| 42 | |[[figureCaption>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.figureCaption.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage]]|Section of the Figure Macro page. The content of the caption is not documented.|- | ||
| 43 | |[[footnote>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.footnote.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage]]|Describes the content as "text" and does not say that it is mandatory.|- | ||
| 44 | |[[gallery>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.gallery.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery%20Macro#HUsage]]|The content and its mandatory flag are missing. The documented defaults of width and height come from the stylesheet, not the descriptor.|- | ||
| 45 | |[[groovy>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.groovy.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Groovy%20Macro#HUsage]]|The content and jars are not documented, output is only mentioned and wiki is not described.|- | ||
| 46 | |[[html>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.html.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/HTML%20Macro#HUsage]]|The legacy table matches the descriptor: only the migration is missing.|- | ||
| 47 | |[[iconPicker>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.iconPicker.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Theme%20Application#HIconPickerMacro]]|Section of the Icon Theme Application page, with no parameter table. prefix is not documented and its stated default is wrong.|- | ||
| 48 | |[[id>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.id.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Id%20Macro#HUsage]]|Only the migration is missing.|- | ||
| 49 | |[[include>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.include.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Include%20Macro#HUsage]]|Gives "document" as the only value of type, while the macro accepts 13 entity types.|- | ||
| 50 | |[[jwplayer>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.jwplayer.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro#HUsage]]|No mandatory or default column, and the values of attachment are split in two rows by version.|- | ||
| 51 | |[[liveData>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.liveData.WebHome]]|(% class="label label-danger" %)To do|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/livedata/display-data/macro/]]|New page. The documented defaults of showPageSizeDropdown and properties do not match the behavior. The content is not in the table.|- | ||
| 52 | |[[mathjax>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.mathjax.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/MathJax/MathJaxMacro/#HUsage]]|No parameter table: the mandatory content is not listed.|- | ||
| 53 | |[[mention>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.mention.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Mentions%20Application/#HUsingtheSourceEditor]]|Section of the Mentions Application page. Marks style and anchor as mandatory, and gives wrong or missing defaults for anchor, type and style.|- | ||
| 54 | |[[menu>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.menu.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Menu%20Application#HUsage]]|label and the content are not documented. Documents modifiers of type that the descriptor does not mention.|- | ||
| 55 | |[[notificationsApplicationsPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsApplicationsPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|Minor. Shared Notification Settings Macros page: no parameter table, no default for target, no mandatory flags.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 56 | |[[notificationsAutoWatchPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsAutoWatchPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|Minor. Shared Notification Settings Macros page: no parameter table, no default for target, no mandatory flags.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 57 | |[[notificationsCustomFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsCustomFiltersPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|Minor. Shared Notification Settings Macros page: no parameter table, no default for target, no mandatory flags.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 58 | |[[notificationsEmailPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsEmailPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|Minor. Shared Notification Settings Macros page: no parameter table, no default for target, no mandatory flags.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 59 | |[[notificationsFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsFiltersPreferences.WebHome]]|(% class="label label-info" %)Other ticket|(% class="label label-danger" %)None|No documentation at all.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 60 | |[[notificationsSystemFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsSystemFiltersPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|Minor. Shared Notification Settings Macros page: no parameter table, no default for target, no mandatory flags.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 61 | |[[office>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.office.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro]]|Marks both reference and attachment as mandatory, while only one is needed. Misdescribes filterStyles. No example of the plain call.|- | ||
| 62 | |[[plantuml>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.plantuml.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML%20Macro#HUsage]]|The content is not in the table, and the documented defaults of format and type differ from the dialog.|- | ||
| 63 | |[[putFootnotes>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.putFootnotes.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage-1]]|Section of the Footnote Macro page, accurate: only the migration is missing.|- | ||
| 64 | |[[python>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.python.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Python%20Macro#HUsage]]|No parameter table. The content, jars and output are not documented, and wiki is only mentioned.|- | ||
| 65 | |[[script>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.script.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Script%20Macro#HUsage]]|The content is not documented and language has no default. Documents the script bindings as if they were parameters.|- | ||
| 66 | |[[tableToChartJS>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.tableToChartJS.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HUsage-1]]|Section of the Chart.js Integration page. The type list misses horizontalBar, width and height have no unit, and the useful options are only documented for chartjs.|- | ||
| 67 | |[[tagcloud>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.tagcloud.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Tag%20Cloud%20Macro#HUsage]]|Says to use the macro in xwiki/2.0 syntax, and gives limit a "no limit" default the macro does not declare.|- | ||
| 68 | |[[template>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.template.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Template%20Macro#HDescription]]|The new Templates page only quotes the call. Documents name as mandatory, which the macro does not declare, and the description of output has a typo.|- | ||
| 69 | |[[toc>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.toc.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/TOC%20Macro#HFromWikiSyntax]]|Only the migration is missing.|- | ||
| 70 | |[[translation>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.translation.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Translation%20Macro#HUsage]]|The content, the message shown when the key has no translation, is not documented.|- | ||
| 71 | |[[tree>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.tree.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Tree%20Macro#HWikiMacro]]|The content and exclusions are not documented, and the description of root differs from the one of the macro.|- | ||
| 72 | |[[uiextension>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.uiextension.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extension%20Macro/#HUsage]]|Does not say what a UI extension is or where to find the identifiers.|- | ||
| 73 | |[[uiextensions>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.uiextensions.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extensions%20Macro/#HUsage]]|Does not say what an extension point is or list the ones of XWiki Standard.|- | ||
| 74 | |[[useravatar>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.useravatar.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/User%20Avatar%20Macro#HUsage]]|Wrong default and description for height. Calls the avatar a URL, while it is an attachment of the profile.|- | ||
| 75 | |[[velocity>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.velocity.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20Macro#HUsage]]|Only filter is documented. The content and jars are missing, and output and wiki are only mentioned.|- | ||
| 76 | |[[wikimacroparameter>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.wikimacroparameter.WebHome]]|(% class="label label-danger" %)To do|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/dev/rendering-macros/wiki-macros/write-wiki-macro/]]|Minor. New page with no parameter table: name is not marked as mandatory, and the Content parameter is never mentioned.|- | ||
| 77 | |||
| 78 | === L3 doc-example === | ||
| 79 | |||
| 80 | JIRA issue: [[XINFRA-526>>https://jira.xwiki.org/browse/XINFRA-526]]. 20 KOs, as of 22 October 2026. The fix is an example of the most common use that renders on XWiki Standard when copied, in the new documentation page of the macro. | ||
| 81 | |||
| 82 | |=Macro|=Status|=Documentation|=Problem|=Fix | ||
| 83 | |[[cache>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.cache.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Cache%20Macro]]|Minor. Every example caches placeholder text, none shows the real use, the result of a slow script, and Example 1 fails when copied.|- | ||
| 84 | |[[content>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.content.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Content%20Macro#HUsage]]|The example uses the confluence/1.0 syntax, missing from XWiki Standard, and renders an error.|- | ||
| 85 | |[[dashboard>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.dashboard.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Dashboard%20Macro#HDescription]]|Minor. No example to copy: the only call is an unclosed ##{{{ {{dashboard}} }}}## in a sentence, and the suggested source is a page hidden from the picker.|- | ||
| 86 | |[[example>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.example.WebHome]]|(% class="label label-info" %)Other ticket|(% class="label label-danger" %)None|No documentation, so no example.|[[XWIKI-25018>>https://jira.xwiki.org/browse/XWIKI-25018]]: the macro becomes internal. | ||
| 87 | |[[faq>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.faq.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application#HFAQMacro]]|Minor. The examples are filter fragments, not macro calls, and filter="tag=test" lists nothing.|- | ||
| 88 | |[[groovy>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.groovy.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Groovy%20Macro#HUsage]]|Minor. The Parameters definition shows an incomplete fragment, and the Example section repeats the first example.|- | ||
| 89 | |[[html>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.html.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/HTML%20Macro#HUsage]]|Minor. The examples show off wiki="true" or hold no HTML: none inserts plain HTML markup.|- | ||
| 90 | |[[iconPicker>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.iconPicker.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Theme%20Application#HIconPickerMacro]]|No documentation example calls the macro.|- | ||
| 91 | |[[include>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.include.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Include%20Macro#HUsage]]|The usage starts with the hidden page parameter. The reference form only comes as Example 4, on a page that does not exist.|- | ||
| 92 | |[[jwplayer>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.jwplayer.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro#HUsage]]|Minor. The block of examples fails when copied, since its 5 standalone calls are in one paragraph.|- | ||
| 93 | |[[notificationsApplicationsPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsApplicationsPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|No example of the most common call, the one of the user profile with user.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 94 | |[[notificationsAutoWatchPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsAutoWatchPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|No example of the most common call, the one of the user profile with user.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 95 | |[[notificationsCustomFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsCustomFiltersPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|No example of the most common call, the one of the user profile with user.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 96 | |[[notificationsEmailPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsEmailPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|No example of the most common call, the one of the user profile with user.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 97 | |[[notificationsFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsFiltersPreferences.WebHome]]|(% class="label label-info" %)Other ticket|(% class="label label-danger" %)None|No documentation, so no example.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 98 | |[[notificationsSystemFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsSystemFiltersPreferences.WebHome]]|(% class="label label-info" %)Other ticket|[[New>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/]]|No example of the most common call, the one of the user profile with user.|[[XWIKI-25468>>https://jira.xwiki.org/browse/XWIKI-25468]]: the macro moves to the Internal category. | ||
| 99 | |[[template>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.template.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Template%20Macro#HDescription]]|The only example uses a placeholder template name and renders nothing. The most common call, loading a macro library, is not documented.|- | ||
| 100 | |[[uiextension>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.uiextension.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extension%20Macro/#HUsage]]|The only example passes the Maven identifier of an extension and renders an error.|- | ||
| 101 | |[[uiextensions>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.uiextensions.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extensions%20Macro/#HUsage]]|The only example uses an extension point with no extension, so it renders nothing.|- | ||
| 102 | |[[velocity>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.velocity.WebHome]]|(% class="label label-danger" %)To do|[[Legacy>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20Macro#HUsage]]|Minor. Example 1 is a template with placeholders and Example 4 fails with a parse error.|- | ||
| 103 | |||
| 104 | == Summary == | ||
| 105 | |||
| 106 | * **12 macros** have a Reference page in the new documentation tree. | ||
| 107 | * **47 macros** are still documented only in the legacy documentation, mostly on [[extensions.xwiki.org>>https://extensions.xwiki.org]]. | ||
| 108 | * **9 macros** have no documentation at all. | ||
| 109 | |||
| 110 | 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. | ||
| 111 | |||
| 112 | == Status per macro == | ||
| 113 | |||
| 114 | |=Macro|=Status|=New documentation|=Legacy documentation|=Notes | ||
| 115 | |[[activity>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.activity.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Activity Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Activity%20Macro]]|\\ | ||
| 116 | |[[async>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.async.WebHome]]|(% class="label label-success" %)Migrated|[["async" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/dev/macros/async-macro/]]|[[Async Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Async%20Macro/#HUsage]]|\\ | ||
| 117 | |[[attachmentGalleryPicker>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.attachmentGalleryPicker.WebHome]]|(% class="label label-success" %)Migrated|[["attachmentGalleryPicker" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/dev/attachments/attachmentgallerypicker-macro/]]|[[Attachment ~> Picker ~> Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Attachment/Picker/Macro/]]|\\ | ||
| 118 | |[[attachmentSelector>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.attachmentSelector.WebHome]]|(% class="label label-success" %)Migrated|[["attachmentSelector" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/dev/attachments/attachmentselector-macro/]]|[[Attachment Application>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Attachment%20Application#HAttachmentSelector]]|Section of a larger page. | ||
| 119 | |[[box>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.box.WebHome]]|(% class="label label-success" %)Migrated|[["box" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/base/page/edit/box-macro/]]|[[Box Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Box%20Macro#HDescription]]|\\ | ||
| 120 | |[[cache>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.cache.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Cache Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Cache%20Macro]]|\\ | ||
| 121 | |[[chart>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.chart.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Chart Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart%20Macro#HUsage]]|\\ | ||
| 122 | |[[chartjs>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.chartjs.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Chart.js Integration>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HChartJSMacro]]|Section of a larger page. | ||
| 123 | |[[children>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.children.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Children Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Children%20Macro/]]|\\ | ||
| 124 | |[[code>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.code.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Code Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro/]]|\\ | ||
| 125 | |[[comment>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.comment.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Comment Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Comment%20Macro]]|\\ | ||
| 126 | |[[container>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.container.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Container Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Container%20Macro]]|\\ | ||
| 127 | |[[content>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.content.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Content Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Content%20Macro#HUsage]]|\\ | ||
| 128 | |[[context>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.context.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Context Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Context%20Macro#HUsage]]|\\ | ||
| 129 | |[[dashboard>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.dashboard.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Dashboard Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Dashboard%20Macro#HDescription]]|\\ | ||
| 130 | |[[display>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.display.WebHome]]|(% class="label label-success" %)Migrated|[["display" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/base/page/edit/display-macro/]]|[[Display Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Display%20Macro#HFromWikiSyntax]]|\\ | ||
| 131 | |[[displayIcon>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.displayIcon.WebHome]]|(% class="label label-success" %)Migrated|[[The displayIcon Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/icons/displayicon-macro/]]|[[Icon Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Macro/#HFromWikiSyntax]]|\\ | ||
| 132 | |[[documents>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.documents.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Documents Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Documents%20Macro#HDescription]]|\\ | ||
| 133 | |[[documentTree>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.documentTree.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Document Tree Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Document%20Tree%20Macro#HWikiMacro]]|\\ | ||
| 134 | |[[error>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.error.WebHome]]|(% class="label label-success" %)Migrated|[["error" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/base/page/edit/error-macro/]]|[[Error Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Error%20Macro#HUsage]]|\\ | ||
| 135 | |[[example>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.example.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|No page found: the Help Application page does not mention it. | ||
| 136 | |[[faq>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.faq.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[FAQ Application>>https://extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application#HFAQMacro]]|Section of a larger page. | ||
| 137 | |[[figure>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.figure.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Figure ~> Figure Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage]]|\\ | ||
| 138 | |[[figureCaption>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.figureCaption.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Figure ~> Figure Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HUsage]]|Section of a larger page. | ||
| 139 | |[[figureTypeRecognizer>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.figureTypeRecognizer.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Figure ~> Figure Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Figure/Figure%20Macro/#HFigureTypeIdentification]]|Section of a larger page. | ||
| 140 | |[[footnote>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.footnote.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Footnote Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage]]|\\ | ||
| 141 | |[[gallery>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.gallery.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Gallery Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery%20Macro#HUsage]]|\\ | ||
| 142 | |[[groovy>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.groovy.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Groovy Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Groovy%20Macro#HUsage]]|\\ | ||
| 143 | |[[html>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.html.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[HTML Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/HTML%20Macro#HUsage]]|\\ | ||
| 144 | |[[iconPicker>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.iconPicker.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Icon Theme Application>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Icon%20Theme%20Application#HIconPickerMacro]]|Section of a larger page. | ||
| 145 | |[[id>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.id.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Id Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Id%20Macro#HUsage]]|\\ | ||
| 146 | |[[include>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.include.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Include Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Include%20Macro#HUsage]]|\\ | ||
| 147 | |[[info>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.info.WebHome]]|(% class="label label-success" %)Migrated|[["info" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/base/page/edit/info-macro/]]|[[Info Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Info%20Macro#HUsage]]|\\ | ||
| 148 | |[[jira>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.jira.WebHome]]|(% class="label label-success" %)Migrated|[["jira" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/extensions/user/jira/display-issues/macro/]]|[[JIRA ~> JIRA Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/JIRA/JIRA%20Macro#HUsage]]|\\ | ||
| 149 | |[[jwplayer>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.jwplayer.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[JW Player Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro#HUsage]]|\\ | ||
| 150 | |[[liveData>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.liveData.WebHome]]|(% class="label label-success" %)Migrated|[["liveData" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/livedata/display-data/macro/]]|[[Live Data Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Live%20Data%20Macro/#HUsage]]|\\ | ||
| 151 | |[[mathjax>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.mathjax.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[MathJax ~> MathJaxMacro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/MathJax/MathJaxMacro/#HUsage]]|\\ | ||
| 152 | |[[mention>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.mention.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Mentions Application>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Mentions%20Application/#HUsingtheSourceEditor]]|Section of a larger page. | ||
| 153 | |[[menu>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.menu.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Menu Application>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Menu%20Application#HUsage]]|Section of a larger page. | ||
| 154 | |[[notifications>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notifications.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Notifications Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Notifications%20Macro/#HUsage]]|\\ | ||
| 155 | |[[notificationsApplicationsPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsApplicationsPreferences.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Admin macro, no page found. | ||
| 156 | |[[notificationsAutoWatchPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsAutoWatchPreferences.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Admin macro, no page found. | ||
| 157 | |[[notificationsCustomFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsCustomFiltersPreferences.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Admin macro, no page found. | ||
| 158 | |[[notificationsEmailPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsEmailPreferences.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Admin macro, no page found. | ||
| 159 | |[[notificationsFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsFiltersPreferences.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Admin macro, no page found. | ||
| 160 | |[[notificationsSystemFiltersPreferences>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.notificationsSystemFiltersPreferences.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Admin macro, no page found. | ||
| 161 | |[[office>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.office.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Not analysed, no page found. | ||
| 162 | |[[pdftoc>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.pdftoc.WebHome]]|(% class="label label-danger" %)Undocumented|-|(% class="label label-danger" %)None|Only the Java source documents it: not on extensions.xwiki.org. | ||
| 163 | |[[plantuml>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.plantuml.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[PlantUML Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML%20Macro#HUsage]]|\\ | ||
| 164 | |[[putFootnotes>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.putFootnotes.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Footnote Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Footnote%20Macro#HUsage-1]]|Section of a larger page. | ||
| 165 | |[[python>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.python.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Python Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Python%20Macro#HUsage]]|\\ | ||
| 166 | |[[script>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.script.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Script Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Script%20Macro#HUsage]]|\\ | ||
| 167 | |[[success>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.success.WebHome]]|(% class="label label-success" %)Migrated|[["success" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/base/page/edit/success-macro/]]|[[Success Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Success%20Macro#HUsage]]|\\ | ||
| 168 | |[[tableToChartJS>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.tableToChartJS.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Chart.js Integration>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart.js%20Integration/#HUsage-1]]|Section of a larger page. | ||
| 169 | |[[tagcloud>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.tagcloud.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Tag Cloud Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Tag%20Cloud%20Macro#HUsage]]|\\ | ||
| 170 | |[[template>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.template.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Template Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Template%20Macro#HDescription]]|\\ | ||
| 171 | |[[toc>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.toc.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[TOC Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/TOC%20Macro#HFromWikiSyntax]]|\\ | ||
| 172 | |[[translation>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.translation.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Translation Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Translation%20Macro#HUsage]]|\\ | ||
| 173 | |[[tree>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.tree.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Tree Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Tree%20Macro#HWikiMacro]]|\\ | ||
| 174 | |[[uiextension>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.uiextension.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Extension Module ~> UI Extension Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extension%20Macro/#HUsage]]|\\ | ||
| 175 | |[[uiextensions>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.uiextensions.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Extension Module ~> UI Extensions Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Module/UI%20Extensions%20Macro/#HUsage]]|\\ | ||
| 176 | |[[useravatar>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.useravatar.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[User Avatar Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/User%20Avatar%20Macro#HUsage]]|\\ | ||
| 177 | |[[velocity>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.velocity.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Velocity Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20Macro#HUsage]]|\\ | ||
| 178 | |[[warning>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.warning.WebHome]]|(% class="label label-success" %)Migrated|[["warning" Macro>>https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/base/page/edit/warning-macro/]]|[[Warning Macro>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Warning%20Macro#HUsage]]|\\ | ||
| 179 | |[[wikimacrocontent>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.wikimacrocontent.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Wiki Macro Tutorial>>https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/#HContent]]|Section of a larger page. | ||
| 180 | |[[wikimacroparameter>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.wikimacroparameter.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Wiki Macro Tutorial>>https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/#HParameters]]|Section of a larger page. | ||
| 181 | |[[wikis>>doc:Proposal.WYSIWYGusabilityofXWikimacros.Audit October 2026.Macros.wikis.WebHome]]|(% class="label label-warning" %)Legacy only|-|[[Wiki Application>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Wiki%20Application#H22Wikis22Macro]]|Section of a larger page. | ||
| 182 | |||
| 183 | == Conventions == | ||
| 184 | |||
| 185 | A macro counts as **Migrated** when a page built on the ##DocApp.Code.RenderingMacroClass## template exists for it under [[documentation>>https://www.xwiki.org/xwiki/bin/view/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. | ||
| 186 | |||
| 187 | 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>>https://forum.xwiki.org/t/doc-brainstorming-consistency-of-the-macro-parameter-table/18862]]. |
