JKN: 1 revision

2013-01-23T14:37:43Z

1 revision

Buaidh: Update.

2010-11-29T21:26:40Z

Update.

New page

{{documentation subpage}}
{{-}}
<center>'''P R O T O T Y P E   T E M P L A T E'''</center>
{{-}}
This '''[[Region|regional]] [[Wikipedia:Userboxes|userbox]] [[Help:Template|template]]''' creates a customizable userbox on your [[Wikipedia:User page|user page]]. This template is normally invoked by other templates as a metatemplate, but it may also be used as a stand-alone template. The template syntax is:

'''<tt><nowiki>{{regbox|option=|region=|title=|the=|adjective=|demonym=|an=|nation=|nationality=|type=|project=|group=|member=|image=|width=|color=|align=|info=}}</nowiki></tt>'''

where:
*<tt>option=</tt> the option number (default=<tt>1</tt>)
*<tt>region=</tt> the required region name as listed in Wikipedia
*<tt>the=</tt> the text "the" if the word "the" normally precedes the region name (default=''<tt>null</tt>'')
*<tt>adjective=</tt> the adjective form of the region name (default=<tt>region</tt> – required for options 41-43, optional for options 34-35, see below)
*<tt>title=</tt> the fully formatted region title to be used in the userbox (default=<tt><nowiki>{{#if:{{{the|}}}|the }}[[{{{region|}}}|'''{{nowrap|{{{region|}}}}}''']]</nowiki></tt>)
*<tt>demonym=</tt> an optional regional demonym ('''only if''' preferred to the adjective for options 34-35, e.g., "This user is a '''[[Wales|Welshman]]'''" ''versus'' "This user is '''[[Wales|Welsh]]'''")
*<tt>an=</tt> the text "an" if the optional regional demonym begins with a vowel sound (default=a)
*<tt>nation=</tt> the nation name as listed in Wikipedia '''only if''' the region is a subdivision of a [[sovereign state]] (default=<tt>region</tt>)
*<tt>nationality=</tt> the national adjective '''only if''' the region is a subdivision of a sovereign state (default=<tt>adjective</tt>)
*<tt>project=</tt> the type of regional WikiProject (required for option 61):
**<tt>project=WikiProject</tt> – a devoted regional WikiProject (default)
**<tt>project=task force</tt> – a WikiProject regional task force
**<tt>project=work group</tt> – a WikiProject regional work group
*<tt>member=</tt> the type of regional project membership (required for option 61):
**<tt>member=member</tt> (default)
**<tt>member=participant</tt>
**<tt>member=volunteer</tt>
*<tt>main=</tt> the responsible regional WikiProject root name (default=<tt>region</tt> – required for option 61)
*<tt>sub=</tt> the WikiProject regional task force or work group root name (default=<tt>region</tt> – required for option 61 if <tt>project=task force</tt> or <tt>project=work group</tt>)
*<tt>align=</tt> an optional horizontal alignment of the userbox text:
**<tt>align=left</tt>
**<tt>align=center</tt> (default)
**<tt>align=right</tt>
*<tt>color=</tt> an optional userbox background color (default=<tt>white</tt>)
*<tt>image=</tt> an optional userbox image (default=<tt><nowiki>Flag of {{#if:{{{the|}}}|the }}{{{region|}}}.svg</nowiki></tt>)
*<tt>width=</tt> an optional maximum width of the userbox image in pixels (default=''<tt>null</tt>'', i.e., limited only by image height of 45 pixels)
*<tt>info=</tt> an optional userbox text. The default userbox text is shown in the table below for each option number:
{|class=wikitable
!option!!default info
|-
|align=center|0||align=center|''<span style="color:cyan">no userbox</span>''
|-
|align=center|1||This user lives in '''[[Region]]'''
|-
|align=center|2||This user resides in '''[[Region]]'''
|-
|align=center|3||This user is a resident of '''[[Region]]'''
|-
|align=center|4||This user is a part-time resident of '''[[Region]]'''
|-
|align=center|5||This user is a student in '''[[Region]]'''
|-
|align=center|6||This user currently studies in '''[[Region]]'''
|-
|align=center|7||This user currently works in '''[[Region]]'''
|-
|align=center|8||This user currently lives in '''[[Region]]'''
|-
|align=center|11||This user is proud to be a native citizen of '''[[Region]]'''
|-
|align=center|12||This user is a proud native citizen of '''[[Region]]'''
|-
|align=center|13||This user is a native citizen of '''[[Region]]'''
|-
|align=center|14||This user is a lifelong citizen of '''[[Region]]'''
|-
|align=center|15||This user was born and lives in '''[[Region]]'''
|-
|rowspan=2 align=center|16||This user is proud to be a naturalized citizen of '''[[Region]]'''
|-
|This user is proud to be a naturalized '''[[Nation|National]]''' citizen living in '''[[Region]]'''
|-
|rowspan=2 align=center|17||This user is a proud naturalized citizen of '''[[Region]]'''
|-
|This user is a proud naturalized '''[[Nation|National]]''' citizen living in '''[[Region]]'''
|-
|rowspan=2 align=center|18||This user is a naturalized citizen of '''[[Region]]'''
|-
|This user is a naturalized '''[[Nation|National]]''' citizen living in '''[[Region]]'''
|-
|align=center|19||This user is a resident citizen of '''[[Region]]'''
|-
|align=center|21||This user is a nonresident citizen of '''[[Region]]'''
|-
|align=center|22||This user is a nonresident native citizen of '''[[Region]]'''
|-
|align=center|23||This user is a nonresident native of '''[[Region]]'''
|-
|align=center|31||This user is a proud native of '''[[Region]]'''
|-
|align=center|32||This user is a native of '''[[Region]]'''
|-
|align=center|33||This user was born in '''[[Region]]'''
|-
|rowspan=2 align=center|34||This user is proud to be '''[[Region|Regional]]'''
|-
|This user is proud to be a '''[[Demonym]]'''
|-
|rowspan=2 align=center|35||This user is '''[[Region|Regional]]'''
|-
|This user is a '''[[Demonym]]'''
|-
|align=center|41||This user is of '''[[Region|Regional]]''' ancestry
|-
|align=center|42||This user is of '''[[Region|Regional]]''' descent
|-
|align=center|43||This user is of '''[[Region|Regional]]''' heritage
|-
|align=center|44||An ancestor of this user was born in '''[[Region]]'''
|-
|align=center|51||This user is an interested native citizen of '''[[Region]]'''
|-
|align=center|52||This user is an interested resident citizen of '''[[Region]]'''
|-
|align=center|53||This user is an interested resident of '''[[Region]]'''
|-
|align=center|54||This user is an interested citizen of '''[[Region]]'''
|-
|align=center|55||This user is an interested native of '''[[Region]]'''
|-
|align=center|56||This user is an interested descendant of '''[[Region]]'''
|-
|align=center|57||This user is interested in '''[[Region]]'''
|-
|rowspan=6 align=center|61||This user is a member of '''[[Wikipedia:WikiProject|WikiProject Region]]'''
|-
|This user participates in '''[[Wikipedia:WikiProject|WikiProject Region]]'''
|-
|This user is a member of the '''[[Wikipedia:WikiProject Council/Guide/Task forces|Region task force]]'''
|-
|This user participates in the '''[[Wikipedia:WikiProject Council/Guide/Task forces|Region task force]]'''
|-
|This user is a member of the '''[[Wikipedia:WikiProject|Region work group]]'''
|-
|This user participates in the '''[[Wikipedia:WikiProject|Region work group]]'''
|-
|align=center|71||This user is from '''[[Region]]'''
|-
|align=center|72||This user is a former resident of '''[[Region]]'''
|-
|align=center|73||This user has lived in '''[[Region]]'''
|-
|align=center|74||This user has visited '''[[Region]]'''
|-
|align=center|75||This user frequently visits '''[[Region]]'''
|-
|align=center|81||This user loves '''[[Region]]'''
|-
|align=center|82||This user longs for '''[[Region]]'''
|-
|align=center|83||This user wishes to be in '''[[Region]]'''
|-
|align=center|91||This user has family in '''[[Region]]'''
|-
|align=center|92||This user has friends in '''[[Region]]'''
|-
|align=center|93||This user has associates in '''[[Region]]'''
|-
|align=center|94||This user does business in '''[[Region]]'''
|-
|align=center|99||This user is associated with '''[[Region]]'''
|-
|}

====Override parameters====
The following additional parameters may be used to override the normal userbox settings:
*<tt>border-c=</tt> an optional userbox border color (default=<tt>black</tt>)
*<tt>id=</tt> an alternate text or image to the default flag image
*<tt>id-a=</tt> an optional horizontal alignment of the <tt>id</tt> (dafault=<tt>left</tt>)
*<tt>id-c=</tt> an optional <tt>id</tt> background color (default=<tt>color</tt> if <tt>width</tt> is specified, otherwise <tt>border-c</tt>)
*<tt>id-w=</tt> an optional width of the <tt>id</tt> in pixels (default=<tt>1</tt>)
*<tt>info-c=</tt> an optional <tt>info</tt> background color (default=<tt>color</tt>)
*<tt>info-fc=</tt> an optional <tt>info</tt> font color (default=<tt>black</tt>)
*<tt>info-lh=</tt> an optional <tt>info</tt> line height (default=<tt><nowiki>{{#expr:0.85+{{{wp-s|10}}}/20}}em</nowiki></tt> for option 61, otherwise <tt>1.25em</tt>)
*<tt>info-s=</tt> an optional <tt>info</tt> font size in pixels (default=<tt>8</tt>)
*<tt>wp-s=</tt> an optional <tt>info</tt> emphasis font size in pixels (default=<tt>10</tt>, used for option 61 only)
See [[Template:Userbox]] for other default userbox settings.

===Examples===
Placing the following [[Wiki markup|Wikitext]] on your [[Wikipedia:User page|user page]]:
:'''<tt><nowiki>{{regbox|region=Wales|option=11}}</nowiki></tt>'''
produces the following [[Wikipedia:Userboxes|userbox]]:
{{regbox|region=Wales|option=11}}
{{-}}{{-}}
The following userboxes demonstrate each of this template's options:
{{regbox|option=1|region=Afghanistan}}
{{regbox|option=2|region=Algeria}}
{{regbox|option=3|region=Argentina}}
{{regbox|option=4|region=Australia}}
{{regbox|option=5|region=Bangladesh}}
{{regbox|option=6|region=Brazil}}
{{regbox|option=7|region=Burma|title='''[[Burma|Myanmar]]'''|image=Flag of Myanmar.svg}}
{{regbox|option=8|region=Canada}}
{{regbox|option=11|region=China}}
{{regbox|option=12|region=Colombia}}
{{regbox|option=13|region=Democratic Republic of the Congo|the=the|title='''[[Democratic Republic of the Congo]]'''}}
{{regbox|option=14|region=Côte d'Ivoire|image=Flag of Cote d'Ivoire.svg}}
{{regbox|option=15|region=Egypt}}
{{regbox|option=16|region=Ethiopia}}
{{regbox|option=16|region=Florida|nation=United States|nationality=American}}
{{regbox|option=17|region=Germany}}
{{regbox|option=17|region=Guanajuato|image=Flag of Guanajuato.png|nation=Mexico|nationality=Mexican}}
{{regbox|option=18|region=Ghana}}
{{regbox|option=18|region=Scotland|nation=United Kingdom|nationality=British}}
{{regbox|option=19|region=India}}
{{regbox|option=21|region=Indonesia}}
{{regbox|option=22|region=Iran}}
{{regbox|option=23|region=Iraq}}
{{regbox|option=31|region=Italy}}
{{regbox|option=32|region=Japan}}
{{regbox|option=33|region=Kenya}}
{{regbox|option=34|region=North Korea|adjective=North Korean}}
{{regbox|option=34|region=South Korea|demonym=South Korean}}
{{regbox|option=35|region=Malaysia|adjective=Malaysian}}
{{regbox|option=35|region=Mexico|demonym=Mexican}}
{{regbox|option=41|region=Morocco|adjective=Moroccan}}
{{regbox|option=42|region=Mozambique|adjective=Mozambican}}
{{regbox|option=43|region=Nigeria|adjective=Nigerian}}
{{regbox|option=44|region=Pakistan}}
{{regbox|option=51|region=Peru}}
{{regbox|option=52|region=Philippines|the=the}}
{{regbox|option=53|region=Poland}}
{{regbox|option=54|region=Romania}}
{{regbox|option=65|region=Saudi Arabia}}
{{regbox|option=56|region=South Africa}}
{{regbox|option=57|region=Sudan}}
{{regbox|option=61|region=Russia}}
{{regbox|option=61|region=Spain|member=participant}}
{{regbox|option=61|region=Galápagos Islands|type=task force|project=Ecuador|image=Flag of Ecuador.svg}}
{{regbox|option=61|region=Southern California|type=task force|member=participant|project=California|image=Flag of California.svg}}
{{regbox|option=61|region=Guam|type=work group|project=Micronesia}}
{{regbox|option=61|region=French Polynesia|type=work group|member=participant|project=Polynesia}}
{{regbox|option=71|region=Syria}}
{{regbox|option=72|region=Taiwan}}
{{regbox|option=73|region=Tanzania}}
{{regbox|option=74|region=Thailand}}
{{regbox|option=75|region=Turkey}}
{{regbox|option=81|region=Uganda}}
{{regbox|option=82|region=Ukraine}}
{{regbox|option=83|region=United Kingdom|the=the}}
{{regbox|option=91|region=United States|the=the|title=[[United States|'''{{nowrap|United States of America}}''']]}}
{{regbox|option=92|region=Uzbekistan}}
{{regbox|option=93|region=Venezuela}}
{{regbox|option=94|region=Vietnam}}
{{regbox|option=99|region=Yemen}}
{{-}}

===See also===
*This template invokes [[Template:Userbox]]
*User category [[Template:Regcats]]
<includeonly>
[[Category:Location user templates]]
[[Category:Wikipedia metatemplates]]
</includeonly>

← Older revision	Revision as of 14:37, 23 January 2013
(No difference)

Template:Regbox/doc - Revision history

JKN: 1 revision

Buaidh: Update.