Uploaded image for project: 'XWiki Platform'
  1. XWiki Platform
  2. XWIKI-25468

Move the notifications preferences macros to the Internal category

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 17.10.14, 18.8.0
    • Notifications
    • None
    • Unknown

    Description

      The six macros that show the notification preferences are listed for every user in the Quick Actions menu and the Insert Macro dialog, in the Notifications category, next to the Notifications macro. They are only meant for the notification preferences of the user profile and of the wiki administration, which already include them, and they make little sense in a content page. Only the Internal and Deprecated categories hide a macro from these lists, for the users who do not display hidden pages.

      The macros to change, each in the default categories of its wiki macro definition, in the notifications UI module:

      notificationsFiltersPreferences is deprecated since XWIKI-18406, replaced by notificationsCustomFiltersPreferences and notificationsSystemFiltersPreferences, so the Deprecated category fits it better than Internal.

      Steps to reproduce

      1. Edit a page with the WYSIWYG editor.
      2. Type {/notif}

        .

      Expected

      Only the Notifications macro is listed, for a user who does not display hidden pages.

      Actual

      The six preferences macros are listed too, among them the deprecated notificationsFiltersPreferences, which is the first result for

      {/filters}

      .

      KOs covered

      Once these macros are hidden, the other usability problems found on them, in their descriptions, their Edit Macro dialog, their rendering in the editor and their documentation, no longer reach the users who insert macros. This issue therefore covers all their KOs:

      Macro KOs
      notificationsApplicationsPreferences C1:user, C4:target, C8:target, D2, D3, E1, E2, E3, L2, L3
      notificationsAutoWatchPreferences C1:user, C4:target, C8:target, D2, D3, D4, E2, E3, L2, L3
      notificationsCustomFiltersPreferences C1:user, C4:target, C8:target, D2, D3, D4, E1, E2, E3, L2, L3
      notificationsEmailPreferences C1:target, C1:user, C4:target, C8:target, D2, D3, D4, E2, E3, L2, L3
      notificationsFiltersPreferences C1:user, D2, D3, D4, E1, E2, E3, L2, L3
      notificationsSystemFiltersPreferences C1:user, C4:target, C8:target, D2, D3, D4, E1, E2, E3, L2, L3

      Impact found on macro fluidity

      These 62 KOs come from the WYSIWYG usability audit of the macros, under its usability criteria. The page of each macro, linked in the table, has the full notes. The category itself is criterion D3: the audit found that each of these macros should be in the Internal category.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              Lucas C Charpentier Lucas
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: