More actions
Created page with "{{High-use|233415}} {{Lua|Module:Category handler|Module:Arguments|Module:Color contrast}} This module does the processing for three userbox templates, {{tl|userbox}}, {{tl|userbox-2}} and {{tl|userbox-r}}. {| class="wikitable" |- ! Template ! Description ! Examples |- | {{tl|userbox}} | Makes userboxes with an id on the left-hand side, or with no id. | {{userbox|id=id}} {{clear}} {{userbox}} |- | {{tl|userbox-2}} | Makes userboxes with an id on both the left- and righ..." |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ | {{doc sub}} | ||
{{Lua|Module:Category handler|Module:Arguments|Module:Color contrast}} | {{Lua|Module:Category handler|Module:Arguments|Module:Color contrast}} | ||
| Line 46: | Line 46: | ||
* {{clc|Userboxes with insufficient color contrast}} | * {{clc|Userboxes with insufficient color contrast}} | ||
* {{clc|Pages with templates in the wrong namespace}} | * {{clc|Pages with templates in the wrong namespace}} | ||
<includeonly> | |||
[[Category:Modules]] | |||
</includeonly> | |||
<noinclude> | |||
[[Category:Module documentation pages]] | |||
</noinclude> | |||
Revision as of 03:52, 2 March 2025
 | 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. |
 | 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.