Module:Userbox/doc explained

This module does the processing for three userbox templates,, and .

Template	Description	Examples
	Makes userboxes with an id on the left-hand side, or with no id.
	Makes userboxes with an id on both the left- and right-hand sides.
	Makes userboxes with an id on the right-hand side.

To use any of these templates from a wiki page, please see the individual template pages for documentation. To generate userboxes directly from Lua, read on.

Generating userboxes from Lua

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

local userbox = require('Module:Userbox')

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

userbox.main(functionName, args)

For use the function name "_userbox"; for use the function name "_userbox-2"; and for use the function name "_userbox-r". The args 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.