Template:Uir/doc

This multiuse regional user master template creates a userbox that identifies the association of a user with a land region and declares appropriate regional user categories when placed on the 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.

Use

The basic syntax of this template is: {{User in region|option=|region=|adj=|demonym=|color=|cres=|ccit=|cint=|cpro=|nocat=}} where:

• option= the option number (default=1, see the Options table below)
• region= the required region name should be the same as the Wikipedia article title
• the=the places a "the " before the region name (default=null)
• full= the optional full form of the region name if different (default={{{region|}}})
• fthe=the places a "the" before the full form of the region name (default=null)
• simple= the simplified form of the region name if different (default={{{region|}}})
• inflect= the inflected form of the region name if different (default={{{region|}}})
• 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)
• title= the fully formatted region title to be used in the userbox (default={{#if:{{{the|}}}|the }}[[{{{region|}}}|<span style="{{#if:{{{wrap|}}}||white-space:nowrap;}}font-size:{{{scale|100%}}};font-weight:bold;">{{{inflect|{{{simple|{{{region|}}}}}}}}}</span>]])
• image= the optional image root name (default=Flag of {{#if:{{{the|}}}|the }}{{{simple|{{{region|}}}}}}.svg}}}{{!}}{{{width|}}}x45px}})
• color= an optional userbox background color (default=white)
• link-c= an alternate link color for dark background colors (default=Wikipedia link colors)
• scale= adjusts the font-size of the region name (default=100%)
• activity= an optional verb phrase for option 1 (default=lives in)
• wrap=wrap allows a multi-word region name to break between lines (default=null)
• main= the root name of the responsible regional WikiProject (default={{{simple|{{{region|}}}}}})
• sub= the root name of the regional subgroup, if any (default={{{simple|{{{region|}}}}}})
• group= the type of regional project group:
  • group=WikiProject (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=coordinator
  • member=other
• wpa= the optional formatted regional project alias (default=null, used for options 41 and 42 only)
• wpm= the optional full name of the regional project membership log (default=null)
• wpt= the optional root name of the regional project userbox template (default=null)
• 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
• anc=yes declares the user page a member of the regional ancestry 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 Wikipedia 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	none	Option 0 allows user categories to be declared without displaying a userbox
1	File:Flag of Afghanistan.svgThis user lives in Afghanistan.	res	res, nres
2	File:Flag of Algeria.svgThis user resides in Algeria.	res	res, nres
3	File:Flag of Angola.svgThis user is a resident of Angola.	res	res, nres
4	File:Flag of Argentina.svgThis user is a part-time resident of Argentina.	res	res, nres
5	File:Flag of Aruba.svgThis user is a student in Aruba.	res	res, nres
6	File:Flag of Australia.svgThis user currently studies in Australia.	res	res, nres
7	File:Flag of Bahrain.svgThis user currently works in Bahrain.	res	res, nres
8	File:Flag of Belarus.svgThis user currently lives in Belarus.	res	res, nres
9	File:Flag of Belgium.svgThis user is proud to be a resident citizen of Belgium.	res, cit	res, nres, ncit
10	File:Flag of Bhutan.svgThis user is a proud resident citizen of Bhutan.	res, cit	res, nres, ncit
11	File:Flag of Bolivia.svgThis user is proud to be a resident native citizen of Bolivia.	res, cit	res, nres, ncit
12	File:Flag of Botswana.svgThis user is a proud resident native citizen of Botswana.	res, cit	res, nres, ncit
13	File:Flag of Brazil.svgThis user is a resident native citizen of Brazil.	res, cit	res, nres, ncit
14	File:Flag of Burkina Faso.svgThis user is a lifelong resident citizen of Burkina Faso.	res, cit	res, nres, ncit
15	File:Flag of Burundi.svgThis user was born and lives in Burundi.	res, cit	res, nres, ncit
16	File:Flag of Canada.svgThis user is proud to be a naturalized resident citizen of Canada.	res, cit
	File:Flag of British Columbia.svgThis user is proud to be a naturalized citizen of Canada living in British Columbia.		res, nres, ncit
17	File:Flag of Mexico.svgThis user is a proud naturalized resident citizen of Mexico.	res, cit
	File:Flag of Puebla.svgThis user is a proud naturalized citizen of Mexico living in Puebla.		res, nres, ncit
18	File:Flag of the United States.svgThis user is a naturalized resident citizen of the United States.	res, cit
	File:Flag of Colorado.svgThis user is a naturalized citizen of the United States living in Colorado.		res, nres, ncit
19	File:Flag of Christmas Island.svgThis user is a resident citizen of Christmas Island.	res, cit	res, nres, ncit
20	File:Flag of Colombia.svgThis user is a citizen of Colombia.	cit	ncit
21	File:Flag of Democratic Republic of the Congo.svgThis user is a nonresident citizen of the Democratic Republic of the Congo.	cit	ncit
22	File:Flag of Costa Rica.svgThis user is a nonresident native citizen of Costa Rica.	cit	ncit
23	File:Flag of Cuba.svgThis user is a proud native citizen of Cuba.	cit	ncit
24	File:Flag of the Czech Republic.svgThis user is a native citizen of the Czech Republic.	cit	ncit
31	File:Flag of France.svgThis user is a resident native citizen interested in France.	res, cit, int	res, int, nres, ncit
32	File:Flag of Gambia.svgThis user is a resident citizen interested in Gambia.	res, cit, int	res, int, nres, ncit
33	File:Flag of Germany.svgThis user is a resident interested in Germany.	res, int	res, int, nres
34	File:Flag of Greece.svgThis user is a citizen interested in Greece.	cit, int	int, ncit
35	File:Flag of Greenland.svgThis user is a native interested in Greenland.	int
36	File:Flag of Guatemala.svgThis user is a descendant interested in Guatemala.	int
37	File:Flag of Guinea.svgThis user is a former resident interested in Guinea.	int
38	File:Flag of Haiti.svgThis user is interested in Haiti.	int
41	File:Flag of India.svgThis user is a member of WikiProject India.	int, pro
	File:Flag of Israel.svgThis user participates in WikiProject Israel.
	File:Flag of Ecuador.svgThis user participates in the Galápagos Islands task force.
	File:Flag of Guam.svgThis user is a member of the Guam work group.
	File:Flag of French Polynesia.svgThis user is a member of the French Polynesia work group.
	File:Flag of Jalisco.svgThis user wishes to create WikiProject Jalisco.
42	File:Flag of Kenya.svgThis user invites you to join WikiProject Kenya.	int, pro
43	File:Flag of Latvia.svgThis user is associated with Latvia.	int, pro
51	File:Flag of Libya.svgThis user is a proud native of Libya.	cit	ncit
52	File:Flag of Luxembourg.svgThis user is a native of Luxembourg.	cit	ncit
53	File:Flag of Madagascar.svgThis user is a nonresident native of Madagascar.	cit	ncit
54	File:Flag of Malaysia.svgThis user was born in Malaysia.	cit	ncit
55	File:Flag of the Marshall Islands.svgThis user is proud to be from the Marshall Islands !	cit	ncit
	File:Flag of Marshall Islands.svgThis user is proud to be   Marshallese !	cit	ncit
56	File:Flag of Mauritania.svgThis user is from Mauritania.	cit	ncit
	File:Flag of Mauritania.svgThis user is a Mauritanian.	cit	ncit
61	File:Flag of Mexico.svgThis user is of Mexican ancestry.	none
62	File:Flag of Moldova.svgThis user is of Moldovan descent.
63	File:Flag of Mongolia.svgThis user is of Mongolian heritage.
64	File:Flag of Montenegro.svgAn ancestor of this user was born in Montenegro.
65	File:Flag of Morocco.svgThis user loves the people of Morocco.
66	File:Flag of Nepal.svgThis user loves the culture of Nepal.
67	File:Flag of Nigeria.svgThis user loves the art of Nigeria.
68	File:Flag of Portugal.svgThis user loves the music of Portugal.
69	File:Flag of Puerto Rico.svgThis user loves the cuisine of Puerto Rico.
72	File:Flag of Romania.svgThis user is a former resident of Romania.
73	File:Flag of Russia.svgThis user has lived in Russia.
74	File:Flag of Saint Barthelemy (local).svgThis user has visited Saint Barthélemy.
75	File:Flag of Saint Kitts and Nevis.svgThis user frequently visits Saint Kitts and Nevis.
76	File:Flag of France.svgThis user wishes to visit Saint Martin.
77	File:Flag of Samoa.svgThis user hiked in Samoa.
78	File:Flag of San Marino.svgThis user hiked to the highest point in San Marino.
79	File:Flag of Saudi Arabia.svgThis user visited the lowest point of Saudi Arabia.
80	File:Flag of Singapore.svgThis user cycled through Singapore.
81	File:Flag of Slovakia.svgThis user loves Slovakia.
82	File:Flag of South Africa.svgThis user longs for South Africa.
83	File:Flag of Spain.svgThis user wishes to be in Spain.
84	File:Flag of Sweden.svgThis user plans to visit Sweden.
85	File:Flag of Switzerland.svgThis user climbed the highest summit of Switzerland.
86	File:Flag of Thailand.svgThis user rode the railways of Thailand.
91	File:Flag of Turkey.svgThis user has family in Turkey.
92	File:Flag of Tuvalu.svgThis user has friends in Tuvalu.
93	File:Flag of the United Kingdom.svgThis user has associates in the United Kingdom.
94	File:Flag of the United States.svgThis user does business in the United States of America.
99	File:Flag of Zimbabwe.svgThis user is associated with Zimbabwe.

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
• bodyclass= an optional bodyclass
• align= an optional horizontal alignment of the userbox text:
  • align=left
  • align=center (default)
  • align=right
  • align=justify
• image= an optional userbox image (default=Flag of {{#if:{{{the|}}}|the }}{{{region|}}}.svg)
• herald= an alternative transparent userbox image to be used in lieu of image
• 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)
• d-s= an alternate demonym emphasis font size in pixels (default=11, used for options 55 and 56 only)
• 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=0)
• 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=1.3em)
• info-p= an alternate info padding (default=0 4px 0 4px)
• info-s= an alternate info font size in pixels (default=8)
• wp-s= an alternate info WikiProject link font size in pixels (default=10, used for options 41 and 42 only)
• d-s= an alternate demonym regional link font size in pixels (default=10, used for options 55 and 56 only)

See Template:Userbox for other default userbox settings.

Restriction

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

Example

Placing the following Wikitext on your user page:

{{User in region
|region=England
|cres=Wikipedians in England
|cnres=Wikipedians in the United Kingdom
|color={{{color|#D5FFFA}}}
}}

produces the following userbox:

File:Flag of England.svgThis user lives in England.

and declares your user page a member of:

• Category:Wikipedians in England
• Category:Wikipedians in the United Kingdom

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

See also

• For help with this userbox template, please post a comment on the template talk page with a {{reply to}} one or more of the previous editors.
• This template invokes Template:Userbox.
• This template is invoked by the multiuse regional user templates.