Difference between revisions of "Module:Userbox/doc"
Jump to navigation
Jump to search
blackwiki>WOSlinker (update cat) |
blackwiki>WOSlinker m (change source to syntaxhighlight) |
||
Line 31: | Line 31: | ||
To generate a userbox directly from Lua, first load the module. | To generate a userbox directly from Lua, first load the module. | ||
− | < | + | <syntaxhighlight lang="lua"> |
local userbox = require('Module:Userbox') | local userbox = require('Module:Userbox') | ||
− | </ | + | </syntaxhighlight> |
You can then run any of the three templates with the code: | You can then run any of the three templates with the code: | ||
− | < | + | <syntaxhighlight lang="lua"> |
userbox.main(functionName, args) | userbox.main(functionName, args) | ||
− | </ | + | </syntaxhighlight> |
For {{tl|userbox}} use the function name "<code>_userbox</code>"; for {{tl|userbox-2}} use the function name "<code>_userbox-2</code>"; and for {{tl|userbox-r}} use the function name "<code>_userbox-r</code>". The <code>args</code> 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. | For {{tl|userbox}} use the function name "<code>_userbox</code>"; for {{tl|userbox-2}} use the function name "<code>_userbox-2</code>"; and for {{tl|userbox-r}} use the function name "<code>_userbox-r</code>". The <code>args</code> 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. |
Revision as of 13:21, 7 July 2020
![]() | This Lua module is used on approximately 261,000 pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
![]() | 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. |
| |||
{{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.
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.