|
| Summary: |
Deprecate the legacy activity macro |
| Issue Type: |
 Improvement |
| Affects Versions: |
17.10.14, 18.8.0 |
| Assignee: |
Unassigned |
| Components: |
Notifications |
| Created: |
22/Oct/26 17:12 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The activity macro, "Activity (legacy)", only exists to keep the pages written for the old Activity Stream application working: it is defined in a legacy module and passes its parameters on to the notifications macro. It is still in the Notifications category, so the Insert Macro dialog and Quick Actions offer it next to the notifications macro, which shows the same events with more options. A user who picks it gets a macro with fewer options, older parameter names and the problems listed below, none of which is worth fixing on a legacy macro. The macro is defined in ActivityMacro.xml. Proposal
- Put the macro in the Deprecated category, which rendering.transformation.macro.hiddenCategories hides from the Insert Macro dialog and Quick Actions by default, so that new pages use the notifications macro. The pages that already call the macro keep rendering it.
- Say in its description that the notifications macro replaces it.
KOs covered
| Macro |
Criterion |
Parameter |
Problem |
| activity |
D2 summary |
|
Says how the macro is built, for backward compatibility with Activity Stream, not that it lists the recent events of the wiki. |
| activity |
D4 quick-action |
|
None of the synonyms finds it: "activity stream", "events", "recent changes" and "feed" give no result. |
| activity |
L2 doc-parameters |
|
The parameters are only documented on the legacy extensions.xwiki.org page, which documents a "subentries" parameter that the macro does not have. |
| activity |
E1 wysiwyg |
|
The editor shows a placeholder, then an empty frame labelled "Activity", never the events, since the output is rendered asynchronously. |
| activity |
E2 errors |
|
Invalid values, like rss="maybe", are read as false and render the list with no message, and the entries value is passed unchecked to the notifications macro. |
| activity |
E3 nesting |
|
In a list item or a table cell, the macro renders "The [activity] macro is a standalone macro and it cannot be used inline." |
| activity |
C1 clarity |
entries |
Does not say that it is the maximum number of events listed, and the notifications macro calls the same value "count". |
| activity |
C4 input-assistance |
entries |
A plain text field for a number of events. |
| activity |
C13 constraints |
entries |
A wiki macro parameter cannot declare a range, and the value is passed unchanged to the notifications macro. |
| activity |
C1 clarity |
wikis |
Does not say whether a wiki is given by its name or its identifier, nor that only the events of these wikis are listed. |
| activity |
C4 input-assistance |
wikis |
A plain text field for a list of wikis. |
| activity |
C1 clarity |
spaces |
Uses "spaces", a term the UI no longer shows, and "local serialized references", a developer wording, with no example. |
| activity |
C4 input-assistance |
spaces |
A plain text field for a list of locations. |
| activity |
C1 clarity |
authors |
Does not give the format of an author, like XWiki.Admin. |
| activity |
C4 input-assistance |
authors |
A plain text field for a list of users. |
| activity |
C4 input-assistance |
tags |
A plain text field for a list of tags. |
Impact found on macro fluidity These 16 KOs come from the WYSIWYG usability audit of the macros, which reviewed the macro like any other since the Insert Macro dialog offers it. Deprecating it covers them: the same needs of the notifications macro are tracked in their own tickets, like XWIKI-25465, XWIKI-25497, XWIKI-25510, XWIKI-25511 and XWIKI-23834. |
|
