Template:Ubxrow/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Ubxrow (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

This template is used for showing userboxes and their properties in a table.

1 Usage
2 Ubxrowsep parameters
3 Ubxrow parameters
4 Category suppression
5 Example
6 See also

[edit] Usage

There are four related templates:

Template	Use
{{ubxrowtop}}	Start the userbox list
{{ubxrowsep}}	Optional named separator
{{ubxrow}}	Userbox row entry
{{end}}	End the userbox list

[edit] Ubxrowsep parameters

{{ubxrowsep| <name> }}

There is one unnamed parameter for the separator title. If the title includes "=", then add the title with |1= <name>. The name is also included as an anchor for direct linking.

[edit] Ubxrow parameters

{{ubxrow
| topic =
| ubx =
| cat =
| p1 =
| p2 =
| p3 =
| p4 =
}}

Parameter	Explanation
topic	Userbox topic; may be wikilinked
ubx	userbox name, include the namespace (Wikipedia:, Template:, User:) but do not wikilink
cat	category invoked by the userbox, do not include Category: and do not wikilink
p1 p2 p3 p4	optional userbox parameters

[edit] 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 automatically invokes category suppression for userboxes that use these methods:

|nocat=true
|category=
|categories=no

Further information: User:Willscrlt/UBX/categories

[edit] Example

{{ubxrowtop}}
{{ubxrowsep|WikiProject Scouting}}
{{ubxrow
|topic=[[Scouting]]
|ubx=Wikipedia:WikiProject Scouting/Userboxes/Scouting WikiProject
|cat=WikiProject Scouting members
|p1=categories=no
}}
{{ubxrow
|topic=[[Wood Badge]]
|ubx=Wikipedia:WikiProject Scouting/Userboxes/Wood Badger
|cat=Wikipedian Wood Badgers
|p1=2
|p2=3
|p3=4
|p4=categories=no
}}
{{ubxrowsep|By association}}
{{ubxrow
|topic=[[Scouts Australia]]
|ubx=Wikipedia:WikiProject Scouting/Userboxes/Scouts Australia
|cat=Wikipedians interested in Scouting
|p1=categories=no
}}
{{end}}

Topic

What to type

Result

Parameters

WikiProject Scouting

Scouting

{{Wikipedia:WikiProject Scouting/Userboxes/Scouting WikiProject}}
Category:WikiProject Scouting members
Linked pages