Module:Notify/doc
This is the documentation page for Module:Notify
This module is intended to facilitate access to the MediaWiki Notification system.
Users who are referenced in a signed edit receive a personal toolbar alert that they have been mentioned. The alert contains a link to the page where they have been mentioned. Because of limitations in the MediaWiki Notification system, references to more than 50 users in a single edit result in no notifications. Unregistered users (IP addresses) do not receive notifications other than from edits to their talk pages.
This module cannot be used directly from wikitext. Please use the associated templates instead. The functions provided here take no parameters, but access those passed to the parent template.
ping
This function creates up to 50 User: references with a single function call.
"Hidden" pings (i.e., pings where the user display names are blank, effectively hiding the User: links) are not supported on purpose.
Usage:
{{#invoke:Notify|ping}}
Template parameters:
- unnamed
- one or more user account names (up to 50)
- label, label1, label2, ..., label50
- (optional, default: same as the corresponding username) user's displayed name (
label
andlabel1
are synonyms.) - prefix
- (optional, default:
@
) string to use before the first username - c
- (optional, default:
and
) conjunction to use before the last username if more than one usernname - p
- (optional, default:
:
) punctuation to use after the last username