Template:Usbk/doc#Category suppression

The {{tlx|Usbk}} template is used for showing a userbox and its properties in a table row. The only mandatory parameter is userbox name. Wrap {{tlx|usbktop}} and {{tlx|usbkbottom}} around uses of this template. You may use {{tlx|usbkbreak}} to insert headers/text breaks in lists.

;{{tlx|Usbk|userbox name}}: Include the full userbox name, i.e. prefix it with User:, Template:, or Wikipedia:.

;{{tlx|Usbk|userbox name|3=param1|4=param2|5=param3}}: For a userbox that uses up to 3 unnamed parameters. If your userbox accepts more parameters, use {{tl|Usbkext}}.

;{{tlx|Usbk|userbox name|3=2=param1=value1|4=3=param2=value2|5=4=param3=value3}}: For a userbox set that uses up to 3 named parameters. (This does not always seem to work.)

;{{tlx|Usbk|userbox name|3=category=user category}}: If the userbox adds user pages into a user category under :Category:Wikipedians. Do not include the Category: prefix.

;{{tlx|Usbk|userbox name|3=comment=text}}: Show some other additional text in the third column.

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.

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)

The following code...

{{usbktop}}

{{usbk|Template:User Arizona|category=Wikipedians in Arizona}}

{{usbk|User:UBX/vandalized|n}}

{{usbk|User:Patricknoddy/Userboxes/Lives in}}

{{usbk|User:Patricknoddy/Userboxes/Lives in|Atlanta|Flag of the United States.svg}}

{{usbkbreak}}

{{usbk|User:Patricknoddy/Userboxes/Lives in|Rome, Georgia|Flag of the United States.svg}}

{{usbk|User:Patricknoddy/Userboxes/Lives in|Savannah, Georgia|Flag of the United States.svg}}

{{usbk|User en-3|comment=Example of a comment in third column: Third level of English knowledge userbox.}}

{{usbkbottom}}

...displays the following table:

{{usbktop}}

{{usbk|Template:User Arizona|category=Wikipedians in Arizona}}

{{usbk|User:UBX/vandalized|n}}

{{usbk|User:Patricknoddy/Userboxes/Lives in}}

{{usbk|User:Patricknoddy/Userboxes/Lives in|Atlanta|Flag of the United States.svg}}

{{usbkbreak}}

{{usbk|User:Patricknoddy/Userboxes/Lives in|Rome, Georgia|Flag of the United States.svg}}

{{usbk|User:Patricknoddy/Userboxes/Lives in|Savannah, Georgia|Flag of the United States.svg}}

{{usbk|User en-3|comment=Example of a comment in third column: Third level of English knowledge userbox.}}

{{usbkbottom}}

• {{Tlx|Usbkext}} a version which supports more user-box parameters for the odd case when more are needed.

{{Markup templates see also}}

{{Sandbox other||

Category:User namespace templates

Category:Userbox arrangement templates

}}