Module:Userbox/doc
 | This is a documentation subpage for Module:Userbox. It contains usage information, categories and other content that is not part of the original Module page. |
 | This Lua module is used on approximately 233,415 pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
 | Uses Lua: |
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. |
| |||
| {{Userbox-2}} | Makes userboxes with an id on both the left- and right-hand sides. |
| |||
| {{Userbox-r}} | 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 {{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.