Difference between revisions of "Module:Side box/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Adem20
m (5 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 mSideBox = require('Module:Side box')
 
local mSideBox = require('Module:Side box')
</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">
 
mSideBox._main(args)
 
mSideBox._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|side box}} 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|side box}} template documentation.

Latest revision as of 07:18, 28 September 2020

This module implements the {{side box}} template.

Usage from wikitext

This module cannot be used directly from wikitext. It can only be used through the {{side box}} 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 mSideBox = require('Module:Side box')

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

mSideBox._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 {{side box}} template documentation.