Template:Uir/doc

This regional userbox template will display a userbox describing your association with a region and will declare up to seven user regional categories when placed on your user page. This template is most commonly invoked by one of the User in Region templates which supply the parameters for this template to function as a metatemplate. The complete syntax is:

{{uir|option=|region=|simple=|inflect=|the=|title=|adj=|demonym=|an=|main=|sub=|group=|member=|cres=|ccit=|cint=|cpro|res=|cit=|int=|pro=|nocat=|nation=|nthe=|nwp=|cnres=|cncit=|cnint=|nres=|ncit=|nint=|align=|color=|image=|width=|border-c=|id=|id-a=|id-c=|id-w=|info=|info-c=|info-fc=|info-lh=|info-s=|wp-s=}}

where:

• option= the option number (default=1, see the Options table below)
• region= the required region name as listed in PBC
• simple= the simplified form of the region name if different (default={{{region|}}})
• inflect= the inflected form of the region name if different (default={{{region|}}})
• the=the places a "the " before the region name (default=null)
• wrap=wrap allows a multi-word region name to break between lines (default=null)
• title= the fully formatted region title to be used in the userbox (default={{#if:{{{the|}}}|the }}[[{{{region|}}}|'''{{#if:{{{wrap|}}}||<span style="white-space:nowrap">}}{{{inflect|{{{simple|{{{region|}}}}}}}}}{{#if:{{{wrap|}}}||</span>}}''']])
• adj= the adjective form of the region name (default={{{inflect|{{{simple|{{{region|}}}}}}}}})
• demonym= an optional regional demonym (only if preferred for options 55 or 56, e.g., "This user is a Dane" versus "This user is from Denmark")
• an=an if the optional regional demonym begins with a vowel sound (default=a)
• main= the root name of the responsible regional PBCProject (default={{{simple|{{{region|}}}}}})
• sub= the root name of the regional subgroup, if any (default={{{simple|{{{region|}}}}}})
• group= the type of regional project group:
  • group=PBCProject (default)
  • group=work group
  • group=task force
  • group=none
  • group=other
• member= the type of regional project membership:
  • member=member (default)
  • member=participant
  • member=volunteer
  • member=other
• cres= the root name of the regional residence user category
• ccit= the root name of the regional citizenship user category
• cint= the root name of the regional interest user category
• cpro= the root name of the regional project membership category
• res=yes declares the user page a member of the regional residence user category
• cit=yes declares the user page a member of the regional citizenship user category
• int=yes declares the user page a member of the regional interest user category
• pro=yes declares the user page a member of the regional project membership category
• nocat=true disables the declaration of user categories

The following eight parameters are used only if the region is a subdivision of a sovereign state:

• nation= the required nation name as listed in PBC only if the region is a subdivision of a sovereign state
• nthe=the places a "the " before the nation name (default=null)
• cnres= the root name of the national residence user category
• cncit= the root name of the national citizenship user category
• cnint= the root name of the national interest user category
• nres=yes declares the user page a member of the national residence user category
• ncit=yes declares the user page a member of the national citizenship user category
• nint=yes declares the user page a member of the national interest user category

Options table

option	userbox example	default user categories
		sovereign state	dependent state
0		Option 0 allows user categories to be declared without displaying a userbox
1	This user lives in Afghanistan	res	res, nres
2	This user resides in Algeria	res	res, nres
3	This user is a resident of Argentina	res	res, nres
4	This user is a part-time resident of Australia	res	res, nres
5	This user is a student in Bangladesh	res	res, nres
6	This user currently studies in Brazil	res	res, nres
7	This user currently works in Myanmar	res	res, nres
8	This user currently lives in Canada	res	res, nres
11	This user is proud to be a resident native citizen of China	res, cit	res, nres, ncit
12	This user is a proud resident native citizen of Colombia	res, cit	res, nres, ncit
13	This user is a resident native citizen of the Democratic Republic of the Congo	res, cit	res, nres, ncit
14	This user is a lifelong resident citizen of Côte d'Ivoire	res, cit	res, nres, ncit
15	This user was born and lives in Egypt	res, cit	res, nres, ncit
16	This user is proud to be a naturalized resident citizen of Ethiopia	res, cit
	This user is proud to be a naturalized citizen of the United States living in Florida		res, nres, ncit
17	This user is a proud naturalized resident citizen of Germany	res, cit
	This user is a proud naturalized citizen of Mexico living in Guanajuato		res, nres, ncit
18	This user is a naturalized resident citizen of Ghana	res, cit
	This user is a naturalized citizen of the United Kingdom living in Scotland		res, nres, ncit
19	This user is a resident citizen of India	res, cit	res, nres, ncit
20	This user is a citizen of Indiana	cit	ncit
21	This user is a nonresident citizen of Indonesia	cit	ncit
22	This user is a nonresident native citizen of Iran	cit	ncit
23	This user is a proud native citizen of Malaysia	cit	ncit
24	This user is a native citizen of Mexico	cit	ncit
31	This user is a resident native citizen interested in Pakistan	res, cit, int	res, int, nres, ncit
32	This user is a resident citizen interested in Peru	res, cit, int	res, int, nres, ncit
33	This user is a resident interested in the Philippines	res, int	res, int, nres
34	This user is a citizen interested in Poland	cit, int	int, ncit
35	This user is a native interested in Romania	int
36	This user is a descendant interested in Saudi Arabia	int
37	This user is a former resident interested in South Africa	int
38	This user is interested in Sudan	int
41	This user is a member of PBCProject Russia	int, pro
	This user participates in PBCProject Spain
	This user is a member of the Galápagos Islands task force
	This user participates in the Southern California task force
	This user is a member of the Guam work group
	This user participates in the French Polynesia work group
	This user wishes to form PBCProject Jalisco
51	This user is a proud native of Iraq	none
52	This user is a native of Italy	none
53	This user is a nonresident native of Japan	none
54	This user was born in Kenya	none
55	This user is proud to be from North Korea	none
	This user is proud to be a South Korean
56	This user is from Madagascar	none
	This user is a Malaysian
61	This user is of Mexican ancestry	none
62	This user is of Moroccan descent	none
63	This user is of Mozambican heritage	none
64	An ancestor of this user was born in Nigeria	none
72	This user is a former resident of Taiwan	none
73	This user has lived in Tanzania	none
74	This user has visited Thailand	none
75	This user frequently visits Turkey	none
81	This user loves Uganda	none
82	This user longs for Ukraine	none
83	This user wishes to be in the United Kingdom	none
91	This user has family in the United States of America	none
92	This user has friends in Uzbekistan	none
93	This user has associates in Venezuela	none
94	This user does business in Vietnam	none
99	This user is associated with Yemen	none

Userbox override parameters

The following additional parameters may be used to override this template's default userbox settings:

• float= an optional horizontal float of the userbox:
  • float=left (default)
  • float=right
  • float=none
• align= an optional horizontal alignment of the userbox text:
  • align=left
  • align=center (default)
  • align=right
  • align=justify
• color= an optional userbox background color (default=white)
• image= an optional userbox image (default=Flag of {{#if:{{{the|}}}|the }}{{{region|}}}.png)
• width= an optional maximum width of the userbox image in pixels (default=null, i.e., limited only by image height of 45 pixels)
• border-c= an alternate userbox border color (default=black)
• id= an alternate text or image to the default flag image
• id-a= an alternate horizontal alignment of the id (default=left)
  • id-a=left (default)
  • id-a=center
  • id-a=right
• id-c= an alternate id background color (default=color if width is specified, otherwise border-c)
• id-w= an alternate width of the id in pixels (default=1)
• info= an alternate userbox text (see the Options table above for the defaults)
• info-c= an alternate info background color (default=color)
• info-class= an optional info-class
• info-fc= an alternate info font color (default=black)
• info-lh= an alternate info line height (default={{#expr:1.05+{{{wp-s|10}}}/40}}em for option 41, otherwise 1.25em)
• info-s= an alternate info font size in pixels (default=8)
• wp-s= an alternate info emphasis font size in pixels (default=10, used for option 41 only)

See Template:Userbox for other default userbox settings.

Restrictions

• This template should be invoked from your user page. This template will declare user categories from the user namespace only.

Example

Placing the following Wikitext on your user page:

{{uir
|region=England
|cres=PBC users in England
|cnres=PBC users in the United Kingdom
|color={{{color|#d5fffa}}}
}}

produces the following userbox:

	This user lives in England

and declares your user page a member of:

• Category:PBC users in England
• Category:PBC users in the United Kingdom

Template:User in England invokes this template to produce the same effect.

See also

• This template invokes Template:Userbox.
• This template is invoked by regional user templates.
• For help with this template, please contact the assigned maintenance group.