notificationsAutoWatchPreferences
Audit
- Macro ID
- notificationsAutoWatchPreferences
- Source
- XS
- Type
- Generator
- Classification reason
- The macro has no content: its whole output is one preference form, the automatic watching of the pages, built from the preferences of a user or of the wiki, given by its parameters and the context, like notifications and mention.
- Status
- Reviewed
- Criteria version
- 15.20
- XWiki version
- 18.8.0
- Audit date
- 2026-10-20
- Auditor
- Compared macros
- notifications mention
Lucas CharpentierSources
Where to gather the information the criteria are checked against, see Gather the sources.
| Source | What it gives | Used for | Where |
|---|---|---|---|
| Documentation | Parameters, default values and examples, including the most common example | L2, L3, and the criteria measured with the most common example | https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/notifications/settings-macros/ |
| Source code | How the macro declares its parameters and content: types, groups, features, advanced and hidden flags, constraints, content type, inline support | C4, C5, C7, C8, C9, C13, E4, E6 | Not recorded yet: search GitHub |
| Macro descriptor | What the Edit Macro dialog is built from, on design.xwiki.org | D1, D2, C1 to C9, E4 | Descriptor, list of macros with their categories |
| Translations | The name, description and parameter names in each language | D1, D2, D4, C1 | l10n.xwiki.org |
| Uses in XWiki pages | How XWiki itself uses the macro, a realistic example when the documentation has none | L3, C2, C3, C6, C8, C9 | Search the xwiki organization on GitHub |
| Compared macros | The audits of the macros of the same type | L1, D3 | notifications, mention |
| Other sources specific to this macro |
|---|
|
| Criterion | Result | Notes |
|---|---|---|
| D1 wording | OK | "Notifications Auto Watch Preferences" is the wording of the other notification settings macros, and the form it shows is titled "Automatic page watching" in the profile and in the administration. The name is long: 36 characters, 6 more than Quick Actions reads, see D4. |
| D2 summary | KO | "Display the preferences of the current user about auto watched pages." repeats the name and is wrong for two of the uses of the macro: with target="wiki" it displays the default preference of the whole wiki, and with user="XWiki.Admin" the preference of another user, which an administrator can edit. It does not say that the result is a single list to choose when a page is watched after an edit, and that a change is saved right away. |
| D3 category | KO | Notifications, but the macro is only meant for the notification administration and preferences UI, where it has its own entry, not to be inserted in a page, so it should be in the Internal category. Only the Internal and Deprecated categories are hidden from the Quick Actions menu and the Insert Macro dialog, for the users who do not display hidden pages; Notifications keeps it listed for every user. See XWIKI-21063. |
| D4 quick-action | KO | the synonyms are "automatic page watching", the title of the form, "watch settings", "auto watch notifications", "notification settings" and "notification preferences". Quick Actions lists the macro for no one of them. It lists it first for the words of its name, "auto watch", "watch", "watch preferences" and "autowatch", for "Notifications Auto Watch Pref" and for the shortened ID "notificationsAutoWatch". The full name has 36 characters and the full ID 33 and Quick Actions reads 30 after the slash, a generic limit of the xwiki-slash plugin, so they give no result and are not counted. In French "notifications d'abonnement" finds "Préférences pour les notifications d'abonnement automatique", and in German "Einstellungen für automatische" finds "Einstellungen für automatische Benachrichtigungen", so the name is translated and found in two other languages. The macro is not listed first by "notif", where it comes 7th after the other notification macros, and "Notifications Filters Preferences (deprecated)" is listed before it, an issue of that macro. Whether each synonym is worth supporting is decided when filing the ticket. |
| L1 consistency | OK | compared with notifications and mention: like notifications, no parameter is mandatory, there is no content and the Quick Action inserts the macro right away, with no dialog, unlike mention, whose reference is mandatory, which is by design. Like notifications, it declares the default of its parameters. |
| L2 doc-parameters | KO | minor: the only documentation is the page Notification Settings Macros of the administration documentation: one table row per settings macro, and one paragraph shared by the five of them, saying that target is user or wiki and that user defaults to the current user. It has no parameter table, no default for target and no mandatory flags. |
| L3 doc-example | KO | the Notification Settings Macros page has no example of the most common call, the call of the user profile in XWiki Standard: it only gives the bare {{notificationsAutoWatchPreferences/}} in its table, and its screenshot shows the email preferences macro. The example used for the other criteria is {{notificationsAutoWatchPreferences user="XWiki.Admin" /}} . |
| I1 pattern | OK | compared with children, the reference generator: from the Quick Actions menu, entry "Notifications Auto Watch Preferences" found with "auto watch", the macro is inserted without a dialog and selected, with an empty paragraph after it. From the Insert Macro dialog the Edit Macro dialog opens, whose fields are both optional, like children. |
| I2 zero-config | OK | inserting from Quick Actions or from the Insert Macro dialog with the default values gives {{notificationsAutoWatchPreferences/}} , which shows the select of the automatic watching of the current user, in the editor and in view mode, with no error. A guest sees an information message instead, and a wiki where the watching is disabled a warning. |
| I3 instant | N/A | |
| I4 cursor | N/A | |
| I5 focus | OK | no parameter is mandatory. The focus is on the first field, Target, a field that few users have to change, while the field they may want, User, is second, see C6. |
| E1 wysiwyg | OK | the editor shows the same select as view mode, "Automatic page watching" with its hint and the current value, after the insertion and after saving and reopening the page, with only the macro frame and its name above. |
| E2 errors | KO | invalid values are accepted silently. {{notificationsAutoWatchPreferences target="maybe"/}} and target="" show the same select as the valid values with no message, filled with the default of the wiki, since the macro only reads the user preference for target="user". The select then sends the change as the target user, whatever the target given, and the service answers 400 and the page shows "Failed to save your settings" at the first change, as checked by hand. user="XWiki.NoSuchUser" and user="NoSuchUser" show the select of a user that does not exist with no message, and a change fails the same way, with a 400. A user without the administration right on the given user sees "You dont have administration right for the given user: {0}.", from the same call as notificationsEmailPreferences, with the placeholder {0} not replaced by the reference, so the message does not say which user. This one is read from the source and was not tried with a second account. |
| E3 nesting | KO | in a list item and in a table cell, * {{notificationsAutoWatchPreferences/}} , the macro shows "The [notificationsAutoWatchPreferences] macro is a standalone macro and it cannot be used inline." in the editor and in view mode. In a box it renders. The macro has no content, so the second half of the measure does not apply. |
| E4 inline-support | OK | the macro declares no inline support, and its output is a labelled select with a hint, a block that cannot be inside a sentence. |
| E5 empty | N/A | E6: the macro has no content. |
| E6 inplace | N/A |
Parameters
| Parameter | C1 clarity | C2 mandatory | C3 defaults | C4 input-assistance | C5 groups | C6 order | C7 alternatives | C8 advanced | C9 technical | C13 constraints | Notes |
|---|---|---|---|---|---|---|---|---|---|---|---|
| target | OK | OK | OK | KO | OK | OK | N/A | KO | OK | N/A | C1: the description, "Target of the macro (could be "user" for the current user or "wiki" for the current wiki)", names the two valid values, so the technical name is explained. It does not say that "wiki" needs the administration right, and "current user" is wrong when the User field is set. Both are minor and the field is OK. C3: the field opens on the declared default, "user", which is the use of the example. C4: a plain text field for a choice between two values, user and wiki, which a select would fit, see E2: any other value is accepted silently. C8, minor: "wiki" shows the default preference of the whole wiki and is only meant for the notifications administration section, which XWiki Standard sets once, while the example of the profile of a user sets only user. The field is not marked as advanced. C13: the accepted values are a fixed list, counted under C4. |
| user | KO | OK | OK | OK | OK | OK | N/A | OK | OK | OK | C1: the description is "User reference of the user for which to display and manipulate the autowatch preferences. This parameter is optional, only used if the target parameter is set to user and default value is the context user. Note that for using this parameter, the context user needs administrator right on the given user reference." The dialog shows the wiki markup user as is. It refers to another field by its parameter ID, "the target parameter", instead of its label, and uses developer terms, "user reference" and "context user", instead of saying that the field empty means the user who views the page, and the sentence about the administration right is hard to follow. The French and German descriptions and names are the English ones. C3: the picker opens empty, which means the user who views the page, as the description says, and the value of the example, the user of the profile, differs on each page, so no value can be preselected. C4: a user picker, which suggests the users matching what the user types. |
Other notes
Outside the criteria: the message of the user without the administration right on the given user shows the unreplaced {0}, see E2.
KOs and tickets
Every KO needs a ticket covering it, see Report the KOs. One ticket can cover several KOs. Known issues filed for this macro are suggested in italics: link them as existing tickets when they cover the KO.
| KO | Criterion | Existing tickets | New tickets |
|---|---|---|---|
| D2 | D2 summary | XWIKI-25468 | |
| D3 | D3 category | XWIKI-21063 | XWIKI-25468 |
| D4 | D4 quick-action | XWIKI-25468 | |
| L2 | L2 doc-parameters | XWIKI-25468, XINFRA-525 | |
| L3 | L3 doc-example | XWIKI-25468, XINFRA-526 | |
| E2 | E2 errors | XCOMMONS-3847 (partial), XRENDERING-823 (partial), XWIKI-25468 | |
| E3 | E3 nesting | XWIKI-25468 | |
| C4:target | C4 input-assistance, target | XWIKI-25468 | |
| C8:target | C8 advanced, target | XWIKI-25468 | |
| C1:user | C1 clarity, user | XWIKI-25468 |
Tickets
| Ticket | Origin | KOs covered | KOs partly covered |
|---|---|---|---|
| XWIKI-21063 | Existing | D3 | |
| XCOMMONS-3847 | New | E2 | |
| XRENDERING-823 | New | E2 | |
| XWIKI-25468 | New | C1:user C4:target C8:target D2 D3 D4 E2 E3 L2 L3 | |
| XINFRA-525 | New | L2 | |
| XINFRA-526 | New | L3 |
Known issues of this macro
No known issue is specific to this macro.
68 more known issues affect every macro: see the Known issues.
