Difference between revisions of "Module:Mass notification/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mr. Stradivarius
(create)
 
m (2 revisions imported)
 
(One intermediate revision by one other user not shown)
Line 9: Line 9:
 
To use this module from other Lua modules, first load the module.
 
To use this module from other Lua modules, first load the module.
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local mMassNotification = require('Module:Mass notification')
 
local mMassNotification = require('Module:Mass notification')
</source>
+
</syntaxhighlight>
  
 
You can then generate the notification links by using the _main function.
 
You can then generate the notification links by using the _main function.
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
mMassNotification._main(groupName)
 
mMassNotification._main(groupName)
</source>
+
</syntaxhighlight>
  
 
<var>groupName</var> is the group name, as a string, as explained in [[Template:Mass notification|the template documentation]].
 
<var>groupName</var> is the group name, as a string, as explained in [[Template:Mass notification|the template documentation]].

Latest revision as of 07:54, 27 September 2020

This module implements the {{mass notification}} template. It is used to send notifications to a WikiProject or other group of users.

Usage from wikitext

Usually you should use {{mass notification}} rather than calling this module directly from #invoke. However, if you want you can use the syntax {{#invoke:Mass notification|main|group name}}. See the template documentation for details about group names.

Usage from Lua modules

To use this module from other Lua modules, first load the module.

local mMassNotification = require('Module:Mass notification')

You can then generate the notification links by using the _main function.

mMassNotification._main(groupName)

groupName is the group name, as a string, as explained in the template documentation.