Module:Userbox/doc
From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Zyxw (talk | contribs) at 20:13, 9 September 2014 (update transclusion count). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision .Revision as of 20:13, 9 September 2014 by Zyxw (talk | contribs) (update transclusion count)
icon 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.
It may contain usage information, categories and other content that is not part of the original module page.
Warning This Lua module is used on 337,000+ 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.
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 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. | id {{{info}}}{{{info}}} |
| {{userbox-2 }} | Makes userboxes with an id on both the left- and right-hand sides. | id1 {{{info}}} id2 |
| {{userbox-r }} | 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.
localuserbox=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.