Jump to content

Template:Usbk/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

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}}
For a userbox that uses up to 3 unnamed parameters. If your userbox accepts more parameters, use {{Usbkext}}.
{{Usbk|userbox name|2=param1=value1|3=param2=value2|4=param3=value3}}
For a userbox set that uses up to 3 named parameters. (This does not always seem to work.)
{{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.
{{Usbk|userbox name|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.

Category suppression

[edit]

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:

Example

[edit]

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:

Code Result
{{Template:User Arizona}}
Usage
Category:Wikipedians in Arizona
{{User:UBX/vandalized|n}}
vn-nThis user page has been vandalized n times.
Usage
{{User:Patricknoddy/Userboxes/Lives in}}
This user lives in The World.
Usage
{{User:Patricknoddy/Userboxes/Lives in|Atlanta|Flag of the United States.svg}}
This user lives in Atlanta.
Usage

{{User:Patricknoddy/Userboxes/Lives in|Rome, Georgia|Flag of the United States.svg}}
This user lives in Rome, Georgia.
Usage
{{User:Patricknoddy/Userboxes/Lives in|Savannah, Georgia|Flag of the United States.svg}}
This user lives in Savannah, Georgia.
Usage
{{Template:User en-3}}
en-3This user can contribute with an advanced level of English.
Usage
Example of a comment in third column: Third level of English knowledge userbox.

See also

[edit]
  • {{Usbk/light}} a lighter weight version, for pages cataloguing many userboxes.
  • {{Usbkext}} a version which supports more user-box parameters for the odd case when more are needed.

Closely related templates: