Module:Userbox/doc

From wikiNonStop
Revision as of 08:17, 1 September 2024 by Majestix (talk | contribs) (1 revision imported: initial setup)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.

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.

Tracking categories