Difference between revisions of "Module:Lua banner/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Pppery
(Undid revision 961232290 by Andrybak (talk) I've created Module:Lua banner/testcases as a redirect, so this is not necessary)
m (10 revisions imported)
 
(One intermediate revision by one other user not shown)
Line 10: Line 10:
 
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 mLuaBanner = require('Module:Lua banner')
 
local mLuaBanner = require('Module:Lua banner')
</source>
+
</syntaxhighlight>
  
 
You can then generate a side box using the _main function.
 
You can then generate a side box using the _main function.
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
mLuaBanner._main(args)
 
mLuaBanner._main(args)
</source>
+
</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 {{tl|lua}} 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 {{tl|lua}} template documentation.

Latest revision as of 07:51, 27 September 2020

This module implements the {{lua}} template.

Usage from wikitext

This module cannot be used directly from wikitext. It can only be used through the {{lua}} template. Please see the template page for documentation.

Usage from Lua modules

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

local mLuaBanner = require('Module:Lua banner')

You can then generate a side box using the _main function.

mLuaBanner._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 {{lua}} template documentation.

Tracking category