Template:Uir/doc

From Festipedia, hosted by the FR Heritage Group

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[edit]

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

  • option= the option number (default=1, see the Options table below)
  • region= the required region name as listed in Festipedia
  • the=the places a "the " before 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>]])
  • color= an optional userbox background color (default=white)
  • link-c= an alternate link color for dark background 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)
  • cres= the root name of the regional residence user category
  • ccit= the root name of the regional citizenship user category
  • canc= the root name of the regional ancestry 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
  • cnanc= the root name of the national ancestry 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
  • nanc=yes declares the user page a member of the national ancestry user category
  • nint=yes declares the user page a member of the national interest user category

Options table[edit]

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
This user lives in Afghanistan.
res res, nres
2
This user resides in Algeria.
res res, nres
3
This user is a resident of Angola.
res res, nres
4
This user is a part-time resident of Argentina.
res res, nres
5
This user is a student in Aruba.
res res, nres
6
This user currently studies in Australia.
res res, nres
7
This user currently works in Bahrain.
res res, nres
8
This user currently lives in Belarus.
res res, nres
9
This user is proud to be a resident citizen of Belgium.
res, cit res, nres, ncit
10
This user is a proud resident citizen of Bhutan.
res, cit res, nres, ncit
11
This user is proud to be a resident native citizen of Bolivia.
res, cit res, nres, ncit
12
This user is a proud resident native citizen of Botswana.
res, cit res, nres, ncit
13
This user is a resident native citizen of Brazil.
res, cit res, nres, ncit
14
This user is a lifelong resident citizen of Burkina Faso.
res, cit res, nres, ncit
15
This user was born and lives in Burundi.
res, cit res, nres, ncit
19
This user is a resident citizen of Christmas Island.
res, cit res, nres, ncit
20
This user is a citizen of Colombia.
cit ncit
21
This user is a nonresident citizen of the Democratic Republic of the Congo.
cit ncit
22
This user is a nonresident native citizen of Costa Rica.
cit ncit
23
This user is a proud native citizen of Cuba.
cit ncit
24
This user is a native citizen of the Czech Republic.
cit ncit
31
This user is a resident native citizen interested in France.
res, cit, int res, int, nres, ncit
32
This user is a resident citizen interested in Gambia.
res, cit, int res, int, nres, ncit
33
This user is a resident interested in Germany.
res, int res, int, nres
34
This user is a citizen interested in Greece.
cit, int int, ncit
35
This user is a native interested in Greenland.
int
36
This user is a descendant interested in Guatemala.
int
37
This user is a former resident interested in Guinea.
int
38
This user is interested in Haiti.
int
51
This user is a proud native of Libya.
cit ncit
52
This user is a native of Luxembourg.
cit ncit
53
This user is a nonresident native of Madagascar.
cit ncit
54
This user was born in Malaysia.
cit ncit
55
This user is proud to be from the Marshall Islands !
cit ncit
This user is proud to be  
Marshallese !
cit ncit
56
This user is from Mauritania.
cit ncit
This user is a
Mauritanian.
cit ncit
61
This user is of Mozambican ancestry.
anc nanc
62
This user is of Nepali descent.
anc nanc
63
This user is of Dutch heritage.
anc nanc
64
An ancestor of this user was born in New Zealand.
anc nanc
72
This user is a former resident of Puerto Rico.
none
73
This user has lived in Russia.
74
This user has visited Saint Barthélemy.
75
This user frequently visits Saint Kitts and Nevis.
76
This user wishes to visit Saint Martin.
77
This user hiked in Samoa.
78
This user hiked to the highest point in San Marino.
79
This user visited the lowest point of Saudi Arabia.
80
This user cycled through Singapore.
81
This user loves Slovakia.
82
This user longs for South Africa.
83
This user wishes to be in Spain.
84
This user plans to visit Sweden.
85
This user climbed the highest summit of Switzerland.
86
This user rode the railways of Thailand.
91
This user has family in Turkey.
92
This user has friends in Tuvalu.
93
This user has associates in the United Kingdom.
94
This user does business in the United States of America.
99
This user is associated with Zimbabwe.

Userbox override parameters[edit]

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=11, used for options 55 and 56 only)

See Template:Userbox for other default userbox settings.

Restriction[edit]

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

Example[edit]

Placing the following Wikitext on your user page:

{{uir
|region=England
|cres=Festipedians in England
|cnres=Festipedians in the United Kingdom
|color={{{color|#D5FFFA}}}
}}

produces the following userbox:

This user lives in England.

and declares your user page a member of:

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

See also[edit]