Template:Uir/doc
This is a documentation subpage for Template:Uir (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
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 Festipediathe=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 colorsscale=
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 categoryccit=
the root name of the regional citizenship user categorycanc=
the root name of the regional ancestry user categorycint=
the root name of the regional interest user categorycpro=
the root name of the regional project membership categoryres=yes
declares the user page a member of the regional residence user categorycit=yes
declares the user page a member of the regional citizenship user categoryanc=yes
declares the user page a member of the regional ancestry user categoryint=yes
declares the user page a member of the regional interest user categorypro=yes
declares the user page a member of the regional project membership categorynocat=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 statenthe=the
places a "the " before the nation name (default=null
)cnres=
the root name of the national residence user categorycncit=
the root name of the national citizenship user categorycnanc=
the root name of the national ancestry user categorycnint=
the root name of the national interest user categorynres=yes
declares the user page a member of the national residence user categoryncit=yes
declares the user page a member of the national citizenship user categorynanc=yes
declares the user page a member of the national ancestry user categorynint=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 | res | res, nres | |
2 | res | res, nres | |
3 | res | res, nres | |
4 | res | res, nres | |
5 | res | res, nres | |
6 | res | res, nres | |
7 | res | res, nres | |
8 | res | res, nres | |
9 | res, cit | res, nres, ncit | |
10 | res, cit | res, nres, ncit | |
11 | res, cit | res, nres, ncit | |
12 | res, cit | res, nres, ncit | |
13 | res, cit | res, nres, ncit | |
14 | res, cit | res, nres, ncit | |
15 | res, cit | res, nres, ncit | |
19 | res, cit | res, nres, ncit | |
20 | cit | ncit | |
21 | cit | ncit | |
22 | cit | ncit | |
23 | cit | ncit | |
24 | cit | ncit | |
31 | res, cit, int | res, int, nres, ncit | |
32 | res, cit, int | res, int, nres, ncit | |
33 | res, int | res, int, nres | |
34 | cit, int | int, ncit | |
35 | int | ||
36 | int | ||
37 | int | ||
38 | int | ||
51 | cit | ncit | |
52 | cit | ncit | |
53 | cit | ncit | |
54 | cit | ncit | |
55 | cit | ncit | |
cit | ncit | ||
56 | cit | ncit | |
cit | ncit | ||
61 | anc | nanc | |
62 | anc | nanc | |
63 | anc | nanc | |
64 | anc | nanc | |
72 | none | ||
73 | |||
74 | |||
75 | |||
76 | |||
77 | |||
78 | |||
79 | |||
80 | |||
81 | |||
82 | |||
83 | |||
84 | |||
85 | |||
86 | |||
91 | |||
92 | |||
93 | |||
94 | |||
99 |
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 optionalbodyclass
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 ofimage
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 alternatedemonym
emphasis font size in pixels (default=11
, used for options 55 and 56 only)id=
an alternate text or image to the default flag imageid-a=
an alternate horizontal alignment of theid
(default=left
)id-a=left
(default)id-a=center
id-a=right
id-c=
an alternateid
background color (default=color
ifwidth
is specified, otherwiseborder-c
)id-w=
an alternate width of theid
in pixels (default=0
)info=
an alternate userbox text (see the Options table above for the defaults)info-c=
an alternateinfo
background color (default=color
)info-class=
an optionalinfo-class
info-fc=
an alternateinfo
font color (default=black
)info-lh=
an alternateinfo
line height (default=1.3em
)info-p=
an alternateinfo
padding (default=0 4px 0 4px
)info-s=
an alternateinfo
font size in pixels (default=8
)wp-s=
an alternateinfo
WikiProject link font size in pixels (default=10
, used for options 41 and 42 only)d-s=
an alternatedemonym
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:
and declares your user page a member of:
Template:User in England invokes this template to produce the same effect.
See also[edit]
- This template invokes Template:Userbox.
- This template is invoked by the multiuse regional user templates.