Template:Userbox table userbox

Template documentation[view] [edit] [history] [purge]

Warning This template is used on approximately 11,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Template wrapper (sandbox)

The following ten userbox table templates can be used to create a userbox table that displays a list of userboxes along with their invoking Wikitext and a link to a list of the pages that invoke each userbox template. Templates can also display text and boxes that link to pages, sections, categories, projects, portals, and noticeboards.

See the userbox table example below to see how these templates work together.

Userbox table top

Template:Userbox table top (formerly Template:yytop) always comes first in a userbox table to create the three column headings and to size the columns. It may also be used to create a centered table title.

{{Userbox table top|title|headers=}}

where:

title is the optional table title.
headers= is the optional column headings switch.
- headers=yes creates three column headings (default)
- headers=no creates no column headings.

Example:
{{Userbox table top|Userbox Templates}} creates:

**Userbox Templates**
Wikitext	userbox	where used

Userbox table userbox

Template:Userbox table userbox (formerly Template:yy) creates a single row in the userbox table with the userbox Wikitext, the userbox, and a link to the list of pages that link to the userbox template.

{{Userbox table|template|par1|...|par12|comment=}}

where:

template is the required template name.
par1|...|par12 are up to 12 optional template parameters.
comment= is an optional comment.

A zero-width space  may be used to represent a missing parameter.

Examples:
{{Userbox table userbox|User roses}} creates:

{{User roses}}

This user cultivates roses .

{{User in New Zealand |5}}

This user is a student in New Zealand .

Userbox table category

Template:Userbox table category (formerly Template:yycat) creates a link to a category. This may be used to show how to link to a category without using a userbox.

{{Userbox table category|category|link=}}

where:

category is the required category name.
link= is the optional link to the category. (default=no)

Example:
{{Userbox table category|Wikipedians in South Africa|link=yes}} creates:

[[Category:Wikipedians in South Africa]]

none

Userbox table text

Template:Userbox table text (formerly Template:yytxt) creates a row of text in the userbox table.

{{Userbox table text|txt1|txt2|txt3|opt=}}

where:

txt1 is the optional text for the table or first column.
txt2 is the optional text for the second column
txt3 is the optional text for the third column
opt= is the optional format parameter:
- opt=1 creates a line of left-justified text (default)
- opt=2 creates a line of table-centered text
- opt=3 creates a line of right-justified text
- opt=4 creates a line of left-justified text for each column
- opt=5 creates a line of column-centered text for each column
- opt=6 creates a line of right-justified text for each column
- opt=7 recreates the column headings of Template:Yytop

If all three optional text parameters are blank or missing, a blank row will be inserted.

Example:
{{Userbox table text|Residence:}} creates:

Residence:

Userbox table link

Template:Userbox table link (formerly Template:yytab) creates a link to another table. It may be used to break an overly large table into subtables.

{{Userbox table link|name|page|desc=|image=|size=|id-w=|info-s=|alone=}}

where:

name is the required name of a country, region, WikiProject, portal, or noticeboard. (See Module:Portal/images)
page is the optional page name of the subtable. (default=Wikipedia:Userboxes/Location/name)
desc= is the optional description of the subtable. (default=name userbox templates)
image= is the optional image file. (default image file from Module:Portal/images)
size= is the optional image size. (default=x45px)
id-w= is the optional image space width. (default=45)
info-s= is the optional font size. (default=9)
alone= is the optional stand alone switch.
- alone=no pointer is part of a table. (default)
- alone=yes pointer in its own table.

Examples:
{{Userbox table link|France|alone=yes}} creates:

See Wikipedia:Userboxes/Location/France for France userbox templates.

France userbox templates

{{Userbox table link|Music composers|Wikipedia:Userboxes/Music/Composers|image=P treble clef.svg|sixe=41px|alone=yes}} creates:

See Wikipedia:Userboxes/Music/Composers for Music composers userbox templates.

Music composers userbox templates

Userbox table regional link

Template:Userbox table regional link (formerly Template:yyreg) creates a link to a city or regional table.

{{Userbox table regional link|name|separator|subsection|text=|image=|info-s=|plain=|alone=}}

where:

name is the required name of a nation or region. (See Module:Portal/images)
separator is the optional separator.
- # for a section. (default)
- / for a subpage.
subsection is the optional section or subpage. (default=Cities)
text= is the optional text. (default=<subsection> of <name>.)
image= is the optional image file. (default image file from Module:Portal/images)
info-s= is the optional font size. (default=9)
plain= is an optional switch
- plain=no use separator and subsection. (default)
- plain=yes ignore separator and subsection.
alone= is the optional stand alone switch.
- alone=no pointer is part of a table. (default)
- alone=yes pointer in its own table.

Example:
{{Userbox table regional link|Puerto Rico|alone=yes}} creates:

See Wikipedia:Userboxes/Location/Puerto Rico#Cities for Cities of Puerto Rico userbox templates.

Cities of Puerto Rico userbox templates

Note: See Template:Userbox table regional link for additional information.

Userbox table project link

Template:Userbox table project link (formerly Template:yywp) creates a link to a WikiProject, Work Group, or Task Force.

{{Userbox table project link|wikiproject|group|type|label|folder=|size=}}

where:

wikiproject is the required WikiProject base name.
group an optional project group base name if any.
type an optional project group type if any.
label an optional WikiProject box label. (default=WikiProject wikiproject or group type)
folder= is an optional WikiProject folder name.
size= is the optional image size. (default=x45px)

Examples:
{{Userbox table project link|New South Wales}} creates:

[[Wikipedia:WikiProject New South Wales]]

WikiProject
New South Wales

linked pages

and {{Userbox table project link|California|Los Angeles|task force}} creates:

[[Wikipedia:WikiProject California/Los Angeles task force]]

Los Angeles
task force

linked pages

Userbox table portal link

Template:Userbox table portal link (formerly Template:yyp) creates a link to a portal.

{{Userbox table portal link|portal|size=}}

where:

portal is the required portal name.
size= is the optional image size. (default=x45px)

Example:
{{Userbox table portal link|South Africa}} creates:

{{Portal:South Africa}}

South Africa portal

linked pages

Userbox table noticeboard link

Template:Userbox table noticeboard link (formerly Template:yynb) creates a link to a noticeboard.

{{Userbox table noticeboard link|noticeboard|size=}}

where:

notice is the required noticeboard base name.
size= is the optional image size. (default=x45px)

Example:
{{Userbox table noticeboard link|Pakistan}} creates:

{{Wikipedia talk:Notice board for Pakistan-related topics}}

Pakistan
notice board

linked pages

Userbox table bottom

Template:Userbox table bottom (formerly Template:yyend) always comes last and completes the userbox table.

{{Userbox table bottom|comment}}

where:

comment is an optional comment to appear at the bottom right of the table.

Example

The following Wikitext:

{{Userbox table top|[[Samoan Archipelago]]}}

{{Userbox table text|American Samoa:}}

{{Userbox table project link|Polynesia|American Samoa|work group}}

{{Userbox table userbox|User in American Samoa}}

{{Userbox table userbox|User wishes to visit|American Samoa}}

{{Userbox table userbox|User American Samoa WG}}

{{Userbox table link|American Samoa|Wikipedia:Userboxes/Location/Oceania#American Samoa}}

{{Userbox table text|Samoa:}}

{{Userbox table project link|Samoa}}

{{Userbox table userbox|User citizen Samoa}}

{{Userbox table userbox|User interest Samoa}}

{{Userbox table userbox|User WP Samoa}}

{{Userbox table link|Samoa|Wikipedia:Userboxes/Location/Oceania#Samoa}}

{{Userbox table bottom|updated 9 February 2023}}

creates the following table:

**Samoan Archipelago**
Wikitext	userbox	where used
American Samoa:
`[[Wikipedia:WikiProject Polynesia/American Samoa work group]]`	American Samoa work group	linked pages
`{{User in American Samoa}}`	This user lives in American Samoa .	User wishes to visit \|American Samoa}}	This user wishes to visit American Samoa .	User American Samoa WG}}	This user participates in the American Samoa work group .	Wikipedia:Userboxes/Location/Oceania#American Samoa for American Samoa userbox templates.	American Samoa userbox templates
Samoa:
`[[Wikipedia:WikiProject Samoa]]`	WikiProject Samoa	linked pages
`{{User citizen Samoa}}`	This user is a citizen of Samoa.	User interest Samoa}}	This user is interested in Samoa.	User WP Samoa}}	This user participates in WikiProject Samoa .	Wikipedia:Userboxes/Location/Oceania#Samoa for Samoa userbox templates.	Samoa userbox templates
updated 9 February 2023

Userbox table top

Userbox table userbox

Userbox table link

Userbox table regional link

Userbox table project link

Userbox table portal link

Userbox table noticeboard link

Userbox table bottom

Example

See also