Module:Userbox/doc

This is a documentation subpage for Module:Userbox.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 331,000 pages, or roughly 1% 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

Makes userboxes with an id on the left-hand side, or with no id.

id {{{info}}}

{{{info}}}

Makes userboxes with an id on both the left- and right-hand sides.

id1 {{{info}}} id2

Makes userboxes with an id on the right-hand side.

{{{info}}} id

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.

Module:Userbox/doc

Generating userboxes from Lua

Tracking categories