Template:Usbk/doc

This template is used for showing a userbox and its properties in a table row. The only mandatory parameter is userbox name. Wrap {{usbktop}} and {{usbkbottom}} around uses of this template.

{{Usbk|userbox name}}

Include the full userbox name, i.e. prefix it with User:, Template:, or Wikipedia:.

{{Usbk|userbox name|param1|param2}}

For a userbox that uses up to 2 unnamed parameters. If your userbox accepts more parameters, make a request on the talk page to expand this template.

{{Usbk|userbox name|2=param1=value1|3=param2=value2}}

For a userbox set that uses up to 2 named parameters.

{{Usbk|userbox name|category=user category}}

If the userbox adds user pages into a user category under Category:Wikipedians. Do not include the Category: prefix.

Category suppression

Some userboxes automatically place the page where it is used into a category. These categories are not appropriate for pages such as lists, so some userboxes support a feature to suppress the automatic category. This template invokes category suppression for those userboxes. There are several methods for category suppression, Usbk supports those that use:

• |nocat=true
• |category=
• |categories=no

Example

The following code...

{{usbktop}}
{{usbk|User:American Eagle/Count|N}}
{{usbk|User:Razorflame/Userpage Vandalized|N}}
{{usbk|User:American Eagle/USA}}
{{usbk|User:Chocolates/User notadmin}}
{{usbkbottom}}

...displays the following table:

Code	Result	Users
{{User:American Eagle/Count|N}}	N+ This user has made over N contributions to Simple Wikipedia.	Transclusions
{{User:Razorflame/Userpage Vandalized|N}}	vn-N This user page has been vandalized N times.	Transclusions
{{User:American Eagle/USA}}	This user lives in the United States of America	Transclusions
{{User:Chocolates/User notadmin}}	This user is not a Wikipedia administrator but would like to be one someday.	Transclusions