Module:Userbox/doc

Ginen Wikipedia
Jump to navigation Jump to search

This is the documentation page for Module:Userbox

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. 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[edit source]

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.