Module:Clickable button/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 00:22, 26 March 2024

This Lua module is used in system messages, and on approximately 1,080,000 pages, or roughly 2% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This module depends on the following other modules:

This module implements the {{Clickable button}} template.

Usage from wikitext

To use this module from wikitext, you should normally use the {{Clickable button}} template. However, it can also be used with the syntax {{#invoke:Clickable button 2|main|args}}. Please see the template page for a list of available parameters.

Usage from Lua modules

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

local mClickableButton = require('Module:Clickable button')

You can then generate a button using the main function.

mClickableButton.main(args)

The args variable should be a table containing the arguments to pass to the module. To see the different arguments that can be specified and how they affect the module output, please refer to the {{Clickable button}} template documentation.

@@ Line 1: / Line 1: @@
 {{Module rating|protected}}
 {{Used in system}}
-{{Lua|Module:Yesno|Module:Arguments}}
+{{Lua|Module:Yesno|Module:Arguments|Module:Delink}}
-This module implements the {{Template link|Clickable button 2}} template.
+This module implements the {{Template link|Clickable button}} template.
 == Usage from wikitext ==
-To use this module from wikitext, you should normally use the {{Template link|Clickable button 2}} template. However, it can also be used with the syntax <code><nowiki>{{#invoke:Clickable button 2|main|</nowiki>''args''<nowiki>}}</nowiki></code>. Please see the template page for a list of available parameters.
+To use this module from wikitext, you should normally use the {{Template link|Clickable button}} template. However, it can also be used with the syntax <code><nowiki>{{#invoke:Clickable button 2|main|</nowiki>''args''<nowiki>}}</nowiki></code>. Please see the template page for a list of available parameters.
 == Usage from Lua modules ==
@@ Line 13: / Line 13: @@
 <syntaxhighlight lang="lua">
-local mClickableButton2 = require('Module:Clickable button 2')
+local mClickableButton = require('Module:Clickable button')
 </syntaxhighlight>
@@ Line 19: / Line 19: @@
 <syntaxhighlight lang="lua">
-mClickableButton2.main(args)
+mClickableButton.main(args)
 </syntaxhighlight>
-The <var>args</var> variable should be a table containing the arguments to pass to the module. To see the different arguments that can be specified and how they affect the module output, please refer to the {{Template link|Clickable button 2}} template documentation.
+The <var>args</var> variable should be a table containing the arguments to pass to the module. To see the different arguments that can be specified and how they affect the module output, please refer to the {{Template link|Clickable button}} template documentation.
 <includeonly>{{Sandbox other||