Module:Userbox/doc
This is the documentation page for Module:Userbox
 | This Lua module is used on approximately 306,000 pages, or roughly 4326% of all 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, {{userbox}}, {{userbox-2}} and {{userbox-r}}.
| Template | Description | Examples |
|---|---|---|
| {{userbox}} | Makes userboxes with an id on the left-hand side, or with no id. | Template:Userbox |
| {{userbox-2}} | Makes userboxes with an id on both the left- and right-hand sides. | Template:Userbox-2 |
| {{userbox-r}} | Makes userboxes with an id on the right-hand side. | Template: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
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 {{userbox}} use the function name "_userbox"; for {{userbox-2}} use the function name "_userbox-2"; and for {{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.
