 | This is the template sandbox page for Template:Userbox table userbox (diff). See also the companion subpage for test cases. |
 | 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: |
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.
- Userbox table top
- Userbox table userbox
- Userbox table category
- Userbox table text
- Userbox table link
- Userbox table regional link
- Userbox table project link
- Userbox table portal link
- Userbox table noticeboard link
- Userbox table begin section
- Userbox table end of section
- Userbox table bottom
See the userbox table example below to see how these templates work together.
Userbox table top
editTemplate:Userbox table top (abbreviation 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:
titleis the optional table title.headers=is the optional column headings switch.headers=yescreates three column headings (default)headers=nocreates no column headings.
Example:
{{Userbox table top|Userbox Templates}} creates:
| Wikitext | userbox | where used |
|---|
Userbox table userbox
editTemplate:Userbox table userbox (abbreviation 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:
templateis the required template name.par1|...|par12are 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}}
|
|
linked pages |
{{Userbox table userbox|User in New Zealand|5|comment=option= 1–99}} creates:
{{User in New Zealand
|
|
linked pages option= 1–99 |
Userbox table category
editTemplate:Userbox table category (abbreviation 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:
categoryis 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 | linked pages |
Userbox table text
editTemplate:Userbox table text (abbreviation Template:yytxt) creates a row of text in the userbox table.
{{Userbox table text|txt1|txt2|txt3|opt=}}
where:
txt1is the optional text for the table or first column.txt2is the optional text for the second columntxt3is the optional text for the third columnopt=is the optional format parameter:opt=1creates a line of left-justified text (default)opt=2creates a line of table-centered textopt=3creates a line of right-justified textopt=4creates a line of left-justified text for each columnopt=5creates a line of column-centered text for each columnopt=6creates a line of right-justified text for each columnopt=7recreates 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
editTemplate:Userbox table link (abbreviation 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:
nameis the required name of a country, region, WikiProject, portal, or noticeboard. (See Module:Portal/images)pageis the optional page name of the subtable. (default=Wikipedia:Userboxes/Location/name)desc=is the optional description of the subtable. (default=nameuserbox 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=nopointer is part of a table. (default)alone=yespointer in its own table.
Examples:
{{Userbox table link|France|alone=yes}} creates:
| See Wikipedia:Userboxes/ |
{{Userbox table link|Music composers|Wikipedia:Userboxes/Music/Composers|image=P treble clef.svg|sixe=41px|alone=yes}} creates:
| See Wikipedia:Userboxes/ |
Userbox table regional link
editTemplate:Userbox table regional link (abbreviation 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:
nameis the required name of a nation or region. (See Module:Portal/images)separatoris the optional separator.#for a section. (default)/for a subpage.
subsectionis 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 switchplain=nouse separator and subsection. (default)plain=yesignore separator and subsection.
alone=is the optional stand alone switch.alone=nopointer is part of a table. (default)alone=yespointer in its own table.
Example:
{{Userbox table regional link|Puerto Rico|alone=yes}} creates:
| See Wikipedia:Userboxes/ |
Note: See Template:Userbox table regional link for additional information.
Userbox table project link
editTemplate:Userbox table project link (abbreviation Template:yywp) creates a link to a WikiProject, Work Group, or Task Force.
{{Userbox table project link|wikiproject|group|type|label|folder=|size=}}
where:
wikiprojectis the required WikiProject base name.groupan optional project group base name if any.typean optional project group type if any.labelan optional WikiProject box label. (default=WikiProjectwikiprojectorgrouptype)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]] | linked pages |
and {{Userbox table project link|California|Los Angeles|task force}} creates:
| [[Wikipedia:WikiProject California/Los Angeles task force]] | linked pages |
Userbox table portal link
editTemplate:Userbox table portal link (abbreviation Template:yyp) creates a link to a portal.
{{Userbox table portal link|portal|size=}}
where:
portalis the required portal name.size=is the optional image size. (default=x45px)
Example:
{{Userbox table portal link|South Africa}} creates:
| {{Portal:South Africa}} | linked pages |
Userbox table noticeboard link
editTemplate:Userbox table noticeboard link (abbreviation Template:yynb) creates a link to a noticeboard.
{{Userbox table noticeboard link|noticeboard|size=}}
where:
noticeis 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}} | linked pages |
Userbox table section
editTemplate:Userbox table begin section and Template:Userbox table end of section (abbreviations Template:yysbeg and Template:yysend) are used to mark any special section of the userbox table.
{{Template:Userbox table begin section|begin_section|anchor_name}}{{Template:Userbox table end of section|end_of_section}}
where:
begin_sectionis the optional text to display at the beginning the section (default: "Begin section").anchor_nameis the optional anchor name, if desired.end_of_sectionis the optional text to display at the end of the section (default: "End of section").
Example:
{{Userbox table begin section|Begin Colorado userboxes}}
{{Userbox table userbox|User invitation|Colorado}}
{{Userbox table userbox|User WikiProject Colorado}}
{{Userbox table end of section|End of Colorado userboxes}}
creates:
Begin Colorado userboxes
{{User invitation
|
|
linked pages | ||
{{User WikiProject Colorado}}
|
|
linked pages |
.jpg){kind=small}
End of Colorado userboxes
Userbox table bottom
editTemplate:Userbox table bottom (abbreviation Template:yyend) always comes last and completes the userbox table.
{{Userbox table bottom|comment}}
where:
commentis an optional comment to appear at the bottom right of the table.
Example
editThe 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 29 April 2025}}
creates the following table:
| Wikitext | userbox | where used | ||
|---|---|---|---|---|
| American Samoa: | ||||
| [[Wikipedia:WikiProject Polynesia/American Samoa work group]] | linked pages | |||
{{User in American Samoa}}
|
|
linked pages | ||
{{User wishes to visit
|
|
linked pages | ||
{{User American Samoa WG}}
|
|
linked pages | ||
| See Wikipedia:Userboxes/ |
||||
| Samoa: | ||||
| [[Wikipedia:WikiProject Samoa]] | linked pages | |||
{{User citizen Samoa}}
|
|
linked pages | ||
{{User interest Samoa}}
|
|
linked pages | ||
{{User WP Samoa}}
|
|
linked pages | ||
| See Wikipedia:Userboxes/ |
||||
| updated 29 April 2025 | ||||
See also
edit- For help with this template, please post a comment on the template talk page with a
{{reply to}}one or more of the previous editors. - For help with userbox templates see Wikiproject Userboxes.