Module:Userbox/doc
 | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original module page. |
Script error: No such module "High-use".
Page Module:Message box/ombox.css has no content.
 | This module depends on the following other modules: |
This module does the processing for three userbox templates, Template:Tl, Template:Tl and Template:Tl.
| Template | Description | Examples | |||
|---|---|---|---|---|---|
| Template:Tl | Makes userboxes with an id on the left-hand side, or with no id. | Page Template:Userbox/styles.css has no content.
| |||
| Template:Tl | Makes userboxes with an id on both the left- and right-hand sides. | Page Template:Userbox/styles.css has no content.
| |||
| Template:Tl | Makes userboxes with an id on the right-hand side. | Page Template:Userbox/styles.css has no content.
|
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 Template:Tl use the function name "_userbox"; for Template:Tl use the function name "_userbox-2"; and for Template:Tl 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.
