Fyrimynd:Usbk/doc

Nýtsla

The {{usbk}} 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. You may use {{usbkbreak}} to insert headers/text breaks in lists.

{{Usbk|userbox name}}

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

{{Usbk|userbox name|param1|param2|param3|param4|param5}}

For a userbox that uses up to 5 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|4=param3=value3|5=param4=value4|6=param5=value5}}

For a userbox set that uses up to 5 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.

Note: If a namespace is not included in the name of the userbox, the "Transclusions" link will be missing the namespace and show the transclusions of a nonexistent page in article space.

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 (see Wikipedia:Category suppression)

Numbering of Userboxen

The userboxen can be numbered by changing the |number= parameter. When you do this you must manually enter what number the userbox is. Also if you want to display the same userbox another time with altered parameters you can use the |cont.= parameter or the |continued= parameter, which will then display "cont." or "continued" respectively.

Example

The following code...

{{usbktop}}
{{usbk|Template:User Arizona|category=Wikipedians in Arizona}}
{{usbk|number=1|User:UBX/vandalized|n}}
{{usbk|number=2|User:Patricknoddy/Userboxes/Lives in}}
{{usbk|number=2|cont.=yes|User:Patricknoddy/Userboxes/Lives in|Atlanta|Flag of the United States.svg}}
{{usbkbreak}}
{{usbk|number=3|User:Patricknoddy/Userboxes/Lives in|Rome, Georgia|Flag of the United States.svg}}
{{usbk|number=3|continued=yes|User:Patricknoddy/Userboxes/Lives in|Savannah, Georgia|Flag of the United States.svg}}
{{usbkbottom}}

...displays the following table:

Fyrimynd:Usbkbreak

Kota	Úrslit
{{Fyrimynd:User Arizona}}	Fyrimynd:User Arizona	Transclusions • Category:Wikipedians in Arizona •
1. {{Brúkari:UBX/vandalized|n}}	Brúkari:UBX/vandalized	Transclusions
2. {{Brúkari:Patricknoddy/Userboxes/Lives in}}	Brúkari:Patricknoddy/Userboxes/Lives in	Transclusions
2. cont.  {{Brúkari:Patricknoddy/Userboxes/Lives in|Atlanta|Flag of the United States.svg}}	Brúkari:Patricknoddy/Userboxes/Lives in	Transclusions
3. {{Brúkari:Patricknoddy/Userboxes/Lives in|Rome, Georgia|Flag of the United States.svg}}	Brúkari:Patricknoddy/Userboxes/Lives in	Transclusions
3. continued  {{Brúkari:Patricknoddy/Userboxes/Lives in|Savannah, Georgia|Flag of the United States.svg}}	Brúkari:Patricknoddy/Userboxes/Lives in	Transclusions