Module:Userbox/doc
This is the documentation page for Module:Userbox
 | This Lua module is used on approximately 233,000 pages. 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. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
This module does the processing for three userbox templates, {{[[Template:userbox |userbox ]]}}, {{[[Template:userbox-2 |userbox-2 ]]}} and {{[[Template:userbox-r |userbox-r ]]}}.
| Template | Description | Examples | |
|---|---|---|---|
| {{[[Template:userbox | userbox
]]}} |
Makes userboxes with an id on the left-hand side, or with no id. | Tɛmpileti:Userbox |
| {{[[Template:userbox-2 | userbox-2
]]}} |
Makes userboxes with an id on both the left- and right-hand sides. | Tɛmpileti:Userbox-2 |
| {{[[Template:userbox-r | userbox-r
]]}} |
Makes userboxes with an id on the right-hand side. | Tɛmpileti:Userbox-r |
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
demeseTo 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 {{[[Template:userbox
|userbox
]]}} use the function name "_userbox"; for {{[[Template:userbox-2
|userbox-2
]]}} use the function name "_userbox-2"; and for {{[[Template:userbox-r
|userbox-r
]]}} 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.