Editing Module:Userbox/doc (section)

== Generating userboxes from Lua ==

To generate a userbox directly from Lua, first load the module.

<syntaxhighlight lang="lua">
local userbox = require('Module:Userbox')
</syntaxhighlight>

You can then run any of the three templates with the code:

<syntaxhighlight lang="lua">
userbox.main(functionName, args)
</syntaxhighlight>

For {{tl|userbox}} use the function name "<code>_userbox</code>"; for {{tl|userbox-2}} use the function name "<code>_userbox-2</code>"; and for {{tl|userbox-r}} use the function name "<code>_userbox-r</code>". The <code>args</code> parameter is a table of arguments to pass to the different userbox functions. To see a list of valid arguments, please consult the individual template pages.