View source for Template:Userbox table userbox/doc

{{Documentation subpage}}
{{High-use}}
{{Lua|Module:Template wrapper}}
The following ten [[Bharatpedia:Userboxes|userbox]] [[Help:Table|table]] [[Help:Template|templates]] can be used to create a userbox table that displays a list of userboxes along with their invoking [[Help:Wikitext|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, [[Help:Categories|categories]], [[Bharatpedia:WikiProject|projects]], [[Bharatpedia:Portal|portals]], and [[Bharatpedia:Noticeboards|noticeboards]].
#[[Template:Userbox table userbox/doc#Userbox table top|Userbox table top]]
#[[Template:Userbox table userbox/doc#Userbox table userbox|Userbox table userbox]]
#[[Template:Userbox table userbox/doc#Userbox table category|Userbox table category]]
#[[Template:Userbox table userbox/doc#Userbox table text|Userbox table text]]
#[[Template:Userbox table userbox/doc#Userbox table link|Userbox table link]]
#[[Template:Userbox table userbox/doc#Userbox table regional link|Userbox table regional link]]
#[[Template:Userbox table userbox/doc#Userbox table project link|Userbox table project link]]
#[[Template:Userbox table userbox/doc#Userbox table portal link|Userbox table portal link]]
#[[Template:Userbox table userbox/doc#Userbox table noticeboard link|Userbox table noticeboard link]]
#[[Template:Userbox table userbox/doc#Userbox table bottom|Userbox table bottom]]
See the [[Template:Userbox table userbox/doc#Example|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.
 '''<samp><nowiki>{{Userbox table top|</nowiki>''title''<nowiki>|headers=}}</nowiki></samp>'''
where:
*'''''<code>title</code>''''' is the optional table title.
*'''<code>headers=</code>''' is the optional column headings switch.
**'''<code>headers=yes</code>''' creates three column headings (default)
**'''<code>headers=no</code>''' creates no column headings.

'''Example''':<br>
'''<code><nowiki>{{Userbox table top|Userbox Templates}}</nowiki></code>''' creates:<br>
{{Userbox table top|Userbox Templates}}
{{Userbox table bottom}}
{{clear}}
<!-- 
Note: Template:Userbox table top is very similar to [[Template:Usbktop]] except:
# Template:Userbox table top default sizes the three columns to 390, 250, and 80 pixels respectively.<br>Template:Usbktop does no default column sizing.
# Template:Userbox table top places the linked labels '''''[[Wiki#Editing|<span style="font-size:80%">Wiki markup</span>]]''''', '''''[[Wikipedia:Userboxes|<span style="font-size:80%">userbox</span>]]''''', and '''''[[Wikipedia:User pages|<span style="font-size:80%">where used</span>]]''''' centered at the top of each column.<br>Template:Usbktop places the labels '''Code''' and '''Result''' left justified at the top of the first two columns only.
# Template:Userbox table top may be used to create a centered table title.
 -->

==Userbox table userbox==
[[Template:Userbox table userbox]] (formerly [[Template:yy]]) creates a single row in the userbox table with the userbox [[Help:Wikitext|Wikitext]], the userbox, and a link to the list of pages that link to the userbox template.
 '''<samp><nowiki>{{Userbox table|</nowiki>''template''|''par1''|''...''|''par12''<nowiki>|comment=}}</nowiki></samp>'''
where:
*'''''<code>template</code>''''' is the required template name.
*'''''<code>par1|...|par12</code>''''' are up to 12 optional template parameters.
*'''<code>comment=</code>''' is an optional comment.
A zero-width space <samp><code>&#82&#8203;03;</code></samp> may be used to represent a missing parameter.

'''Examples''':<br>
'''<code><nowiki>{{Userbox table userbox|User roses}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table userbox|User roses}}
{{Userbox table bottom}}
{{clear}}

'''<code><nowiki>{{Userbox table userbox|User in New Zealand|5|comment=option= 1–99}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table userbox|User in New Zealand|5|comment=option= 1–99}}
{{Userbox table bottom}}
{{clear}}
<!-- 
Note: Template:Userbox table userbox is similar to [[Template:Usbk]] except:
#Template:Userbox table userbox will pass up to 12 parameters to the called template.<br>Template:Usbk will pass no more than three parameters to the called template.
#Template:Userbox table userbox forces all cells to align to the left.<br>Template:Usbk uses the default object alignment.
#Template:Userbox table userbox uses the same [[Wikipedia:Category suppression|category suppression]] as [[Template:Usbk]]. -->

==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.
 '''<samp><nowiki>{{Userbox table category|</nowiki>''category''<nowiki>|link=}}</nowiki></samp>'''
where:
*'''''<code>category</code>''''' is the required category name.
*'''<code>link=</code>''' is the optional link to the category. (default=no)

'''Example''':<br>
'''<code><nowiki>{{Userbox table category|Bharatpedias in South Africa|link=yes}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table category|Bharatpedias in South Africa|link=yes}}
{{Userbox table bottom}}
{{clear}}

==Userbox table text==
[[Template:Userbox table text]] (formerly [[Template:yytxt]]) creates a row of text in the userbox table.
 '''<samp><nowiki>{{Userbox table text|</nowiki>''txt1''<nowiki>|</nowiki>''txt2''<nowiki>|</nowiki>''txt3''<nowiki>|opt=}}</nowiki></samp>'''
where:
*'''''<code>txt1</code>''''' is the optional text for the table or first column.
*'''''<code>txt2</code>''''' is the optional text for the second column
*'''''<code>txt3</code>''''' is the optional text for the third column
*'''<code>opt=</code>''' is the optional format parameter:
**'''<code>opt=1</code>''' creates a line of left-justified text (default)
**'''<code>opt=2</code>''' creates a line of table-centered text
**'''<code>opt=3</code>''' creates a line of right-justified text
**'''<code>opt=4</code>''' creates a line of left-justified text for each column
**'''<code>opt=5</code>''' creates a line of column-centered text for each column
**'''<code>opt=6</code>''' creates a line of right-justified text for each column
**'''<code>opt=7</code>''' recreates the column headings of Template:Yytop
If all three optional text parameters are blank or missing, a blank row will be inserted.

'''Example''':<br>
'''<code><nowiki>{{Userbox table text|Residence:}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table text|Residence:}}
{{Userbox table bottom}}
{{clear}}
<!-- 
Note: [[Template:Usbkbreak]] centers text on only the first two columns and has no other options.
 -->

==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.
 '''<samp><nowiki>{{Userbox table link</nowiki>|<var>name</var>|<var>page</var>|desc=|image=|size=|id-w=|info-s=|alone=<nowiki>}}</nowiki></samp>'''
where:
*'''''<code>name</code>''''' is the required name of a country, region, WikiProject, portal, or noticeboard. (See [[Module:Portal/images]])
*'''''<code>page</code>''''' is the optional page name of the subtable.  (default=Wikipedia:Userboxes/Location/'''<code>name</code>''')
*'''<code>desc=</code>''' is the optional description of the subtable.  (default='''<code>name</code>''' userbox templates)
*'''<code>image=</code>''' is the optional image file.  (default image file from [[Module:Portal/images]])
*'''<code>size=</code>''' is the optional image size.  (default='''<code>x45px</code>''')
*'''<code>id-w=</code>''' is the optional image space width.  (default='''<code>45</code>''')
*'''<code>info-s=</code>''' is the optional font size.  (default='''<code>9</code>''')
*'''<code>alone=</code>''' is the optional stand alone switch.
**'''<code>alone=no</code>''' pointer is part of a table.  (default)
**'''<code>alone=yes</code>''' pointer in its own table.

'''Examples''':<br>
'''<code><nowiki>{{Userbox table link|France|alone=yes}}</nowiki></code>''' creates:<br>
{{Userbox table link|France|alone=yes}}
{{clear}}

'''<code><nowiki>{{Userbox table link|Music composers|Wikipedia:Userboxes/Music/Composers|image=P treble clef.svg|sixe=41px|alone=yes}}</nowiki></code>''' creates:<br>
{{Userbox table link|Music composers|Wikipedia:Userboxes/Music/Composers|image=P treble clef.svg|sixe=41px|alone=yes}}
{{clear}}
<!-- 
Note: Template:Userbox table link is somewhat similar to [[Template:usee]].
 -->

==Userbox table regional link==
[[Template:Userbox table regional link]] (formerly [[Template:yyreg]]) creates a link to a city or regional table.
 '''<samp><nowiki>{{Userbox table regional link</nowiki>|<var>name</var>|<var>separator</var>|<var>subsection</var>|text=|image=|info-s=|plain=|alone=<nowiki>}}</nowiki></samp>'''
where:
*'''''<code>name</code>''''' is the required name of a nation or region. (See [[Module:Portal/images]])
*'''''<code>separator</code>''''' is the optional separator.
**'''<code>#</code>''' for a section.  (default)
**'''<code>/</code>''' for a subpage.
*'''''<code>subsection</code>''''' is the optional section or subpage. (default=<code>Cities</code>)
*'''<code>text=</code>''' is the optional text.  (default=<subsection> of <name>.)
*'''<code>image=</code>''' is the optional image file.  (default image file from [[Module:Portal/images]])
*'''<code>info-s=</code>''' is the optional font size.  (default='''<code>9</code>''')
*'''<code>plain=</code>''' is an optional switch
**'''<code>plain=no</code>''' use separator and subsection. (default)
**'''<code>plain=yes</code>''' ignore separator and subsection. 
*'''<code>alone=</code>''' is the optional stand alone switch.
**'''<code>alone=no</code>''' pointer is part of a table. (default)
**'''<code>alone=yes</code>''' pointer in its own table.

'''Example''':<br>
'''<code><nowiki>{{Userbox table regional link|Puerto Rico|alone=yes}}</nowiki></code>''' creates:<br>
{{Userbox table regional link|Puerto Rico|alone=yes}}

'''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 [[Wikipedia:WikiProject|WikiProject]], [[Wikipedia:WikiProject Council/Guide/Task forces|Work Group]], or [[Wikipedia:WikiProject Council/Guide/Task forces|Task Force]].
 '''<samp><nowiki>{{Userbox table project link|</nowiki>''wikiproject''<nowiki>|</nowiki>''group''<nowiki>|</nowiki>''type''<nowiki>|</nowiki>''label''<nowiki>|folder=|size=}}</nowiki></samp>'''
where:
*'''''<code>wikiproject</code>''''' is the required WikiProject base name.
*'''''<code>group</code>''''' an optional project group base name if any.
*'''''<code>type</code>''''' an optional project group type if any.
*'''''<code>label</code>''''' an optional WikiProject box label.  (default=WikiProject '''''<code>wikiproject</code>''''' or '''''<code>group</code> <code>type</code>''''')
*'''<code>folder=</code>''' is an optional WikiProject folder name.
*'''<code>size=</code>''' is the optional image size.  (default='''<code>x45px</code>''')

'''Examples''':<br>
'''<code><nowiki>{{Userbox table project link|New South Wales}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table project link|New South Wales}}
{{Userbox table bottom}}
and '''<code><nowiki>{{Userbox table project link|California|Los Angeles|task force}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table project link|California|Los Angeles|task force}}
{{Userbox table bottom}}
{{clear}}
<!-- 
Note: [[Template:WikiProject box]] creates a smaller standalone WikiProject box.
 -->

==Userbox table portal link==
[[Template:Userbox table portal link]] (formerly [[Template:yyp]]) creates a link to a [[Bharatpedia:Portal|portal]].
 '''<samp><nowiki>{{Userbox table portal link|</nowiki>''portal''<nowiki>|size=}}</nowiki></samp>'''
where:
*'''''<code>portal</code>''''' is the required portal name.
*'''<code>size=</code>''' is the optional image size.  (default='''<code>x45px</code>''')

'''Example''':<br>
'''<code><nowiki>{{Userbox table portal link|South Africa}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table portal link|South Africa}}
{{Userbox table bottom}}
{{clear}}
<!-- 
Note: [[Template:Portal]] creates a smaller standalone portal box. -->

==Userbox table noticeboard link==
[[Template:Userbox table noticeboard link]] (formerly [[Template:yynb]]) creates a link to a [[Bharatpedia:Noticeboards|noticeboard]].
 '''<samp><nowiki>{{Userbox table noticeboard link|</nowiki>''noticeboard''<nowiki>|size=}}</nowiki></samp>'''
where:
*'''''<code>notice</code>''''' is the required noticeboard base name.
*'''<code>size=</code>''' is the optional image size.  (default='''<code>x45px</code>''')

'''Example''':<br>
'''<code><nowiki>{{Userbox table noticeboard link|Pakistan}}</nowiki></code>''' creates:<br>
{{Userbox table top|headers=no}}
{{Userbox table noticeboard link|Pakistan}}
{{Userbox table bottom}}
{{clear}}
<!-- 
Note: [[Template:Noticeboard box]] creates a smaller standalone notice board box.
 -->

==Userbox table bottom==
[[Template:Userbox table bottom]] (formerly [[Template:yyend]]) always comes last and completes the userbox table.
 '''<code><nowiki>{{Userbox table bottom|</nowiki>''comment''<nowiki>}}</nowiki></code>'''
where:
*'''<code>comment</code>''' is an optional comment to appear at the bottom right of the table.
<!-- 
Note: [[Template:Usbkbottom]] is similar to Template:Userbox table bottom but does not permit a comment line.
 -->

==Example==
The following [[Help:Wikitext|Wikitext]]:<br>
:<samp><nowiki>{{Userbox table top|[[Samoan Archipelago]]}}</nowiki></samp>
:<samp><nowiki>{{Userbox table text|American Samoa:}}</nowiki></samp>
:<samp><nowiki>{{Userbox table project link|Polynesia|American Samoa|work group}}</nowiki></samp>
:<samp><nowiki>{{Userbox table userbox|User in American Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table userbox|User wishes to visit|American Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table userbox|User American Samoa MG}}</nowiki></samp>
:<samp><nowiki>{{Userbox table link|American Samoa|Bharatpedia:Userboxes/Location/Oceania#American Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table text|Samoa:}}</nowiki></samp>
:<samp><nowiki>{{Userbox table project link|Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table userbox|User citizen Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table userbox|User interest Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table userbox|User BP Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table link|Samoa|Bharatpedia:Userboxes/Location/Oceania#Samoa}}</nowiki></samp>
:<samp><nowiki>{{Userbox table bottom|updated 9 February 2023}}</nowiki></samp>
creates the following table:<br>
{{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 MG}}
{{Userbox table link|American Samoa|Bharatpedia: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 BP Samoa}}
{{Userbox table link|Samoa|Wikipedia:Userboxes/Location/Oceania#Samoa}}
{{Userbox table bottom|updated 9 February 2023}}

==See also==
{{help}}
* For help with userbox templates see [[Bharatpedia:Wikiproject Userboxes|Wikiproject Userboxes]].
{{BP:UBS}}
<includeonly>{{Sandbox other||
[[Category:Userbox arrangement templates]]
}}</includeonly>