Jump to: navigation, search

Difference between revisions of "Template:Uir/doc"


(remove sandbox)
 
m (1 revision)
 
(No difference)

Latest revision as of 14:37, 23 January 2013

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

produces the following userbox:

Flag of England.svg This user lives in England

and declares your user page a member of:

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

See also