Hi!
Context
During the WYSIWYG usability audit of the macros, I found a few macros that the Insert Macro dialog and Quick Actions offer to every user, although they aren’t meant to be inserted in a content page.
Only two categories can hide a macro: Internal and Deprecated. They are the default value of rendering.transformation.macro.hiddenCategories, and the macros in them are left out of both the Insert Macro dialog and Quick Actions for the users who don’t display hidden pages. Pages that already call these macros keep rendering them; only the lists change. We already did this for spaces, spacesIndex and workspaces in XWIKI-14561.
Proposal
- Move the notification preferences macros to Internal (XWIKI-25468):
notificationsApplicationsPreferences,notificationsAutoWatchPreferences,notificationsCustomFiltersPreferences,notificationsEmailPreferencesandnotificationsSystemFiltersPreferences. They are only meant for the notification preferences of the user profile and wiki administration. Today they show up in the Notifications category next to the Notifications macro, and typing/notiflists all of them. The 6th one,notificationsFiltersPreferences, goes to Deprecated instead, since it has been replaced by the custom and system filters macros (XWIKI-18406). - Move the
examplemacro of the Help application to Internal (XWIKI-25018). It only builds the Help pages, where it shows a rendered example next to its source: it is used 19 times in theHelp.Macros.*pages and documented nowhere for users. It is in the Formatting category today, next to macros users actually insert. - Move the
activitymacro, “Activity (legacy)”, to Deprecated (XWIKI-16047). It only keeps the pages written for the old Activity Stream application working: it lives in a legacy module and passes its parameters on to the Notifications macro. It is still offered in the Notifications category, next to the Notifications macro, which shows the same events with more options. Its description would also say that the Notifications macro replaces it.
Opinion
+1 for the 3 points because:
- None of these macros actually target users.
- They clutter the lists, sometimes right next to the macro the user is looking for, like
/notifor/filters. - It’s cheap and safe: only the default category changes, existing pages keep rendering the same, and the users who display hidden pages will still see them.
- Those macros are far from being usable, marking them as internal/deprecated makes our intent clear (we won’t improve their usability).
Conclusion
- Do you agree to move the 5 notification preferences macros to Internal, and
notificationsFiltersPreferencesto Deprecated? - Do you agree to move the
examplemacro to Internal? - Do you agree to move the
activitymacro to Deprecated?
Thank you in advance for sharing your opinion!
Lucas C.