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:

 

where: The following eight parameters are used only if the region is a subdivision of a sovereign state:
 * 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= )
 * inflect= the inflected form of the region name if different (default= )
 * the=the</tt> places a "the " before the region name (default=null</tt>)
 * wrap=wrap</tt> allows a multi-word region name to break between lines (default=null</tt>)
 * title=</tt> the fully formatted region title to be used in the userbox (default= | </tt>)
 * adj=</tt> the adjective form of the region name (default= </tt>)
 * demonym=</tt> 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</tt> if the optional regional demonym begins with a vowel sound (default=a</tt>)
 * main=</tt> the root name of the responsible regional WikiProject (default= </tt>)
 * sub=</tt> the root name of the regional subgroup, if any (default= </tt>)
 * group=</tt> the type of regional project group:
 * <tt>group=WikiProject</tt> (default)
 * <tt>group=work group</tt>
 * <tt>group=task force</tt>
 * <tt>group=none</tt>
 * <tt>group=</tt>other
 * <tt>member=</tt> the type of regional project membership:
 * <tt>member=member</tt> (default)
 * <tt>member=participant</tt>
 * <tt>member=volunteer</tt>
 * <tt>member=</tt>other
 * <tt>cres=</tt> the root name of the regional residence user category
 * <tt>ccit=</tt> the root name of the regional citizenship user category
 * <tt>cint=</tt> the root name of the regional interest user category
 * <tt>cpro=</tt> the root name of the regional project membership category
 * <tt>res=yes</tt> declares the user page a member of the regional residence user category
 * <tt>cit=yes</tt> declares the user page a member of the regional citizenship user category
 * <tt>int=yes</tt> declares the user page a member of the regional interest user category
 * <tt>pro=yes</tt> declares the user page a member of the regional project membership category
 * <tt>nocat=true</tt> disables the declaration of user categories
 * <tt>nation=</tt> the required nation name as listed in Wikipedia only if the region is a subdivision of a sovereign state
 * <tt>nthe=the</tt> places a "the " before the nation name (default=<tt>null</tt>)
 * <tt>cnres=</tt> the root name of the national residence user category
 * <tt>cncit=</tt> the root name of the national citizenship user category
 * <tt>cnint=</tt> the root name of the national interest user category
 * <tt>nres=yes</tt> declares the user page a member of the national residence user category
 * <tt>ncit=yes</tt> declares the user page a member of the national citizenship user category
 * <tt>nint=yes</tt> declares the user page a member of the national interest user category

Userbox override parameters
The following additional parameters may be used to override this template's default userbox settings: See Template:Userbox for other default userbox settings.
 * <tt>float=</tt> an optional horizontal float of the userbox:
 * <tt>float=left</tt> (default)
 * <tt>float=right</tt>
 * <tt>float=none</tt>
 * <tt>align=</tt> an optional horizontal alignment of the userbox text:
 * <tt>align=left</tt>
 * <tt>align=center</tt> (default)
 * <tt>align=right</tt>
 * <tt>align=justify</tt>
 * <tt>color=</tt> an optional userbox background color (default=<tt>white</tt>)
 * <tt>image=</tt> an optional userbox image (default=<tt> Flag of .svg </tt>)
 * <tt>width=</tt> an optional maximum width of the userbox image in pixels (default=null, i.e., limited only by image height of 45 pixels)
 * <tt>border-c=</tt> an alternate userbox border color (default=<tt>black</tt>)
 * <tt>id=</tt> an alternate text or image to the default flag image
 * <tt>id-a=</tt> an alternate horizontal alignment of the <tt>id</tt> (default=<tt>left</tt>)
 * <tt>id-a=left</tt> (default)
 * <tt>id-a=center</tt>
 * <tt>id-a=right</tt>
 * <tt>id-c=</tt> an alternate <tt>id</tt> background color (default=<tt>color</tt> if <tt>width</tt> is specified, otherwise <tt>border-c</tt>)
 * <tt>id-w=</tt> an alternate width of the <tt>id</tt> in pixels (default=<tt>1</tt>)
 * <tt>info=</tt> an alternate userbox text (see the Options table above for the defaults)
 * <tt>info-c=</tt> an alternate <tt>info</tt> background color (default=<tt>color</tt>)
 * <tt>info-fc=</tt> an alternate <tt>info</tt> font color (default=<tt>black</tt>)
 * <tt>info-lh=</tt> an alternate <tt>info</tt> line height (default=<tt> em </tt> for option 41, otherwise <tt>1.25em</tt>)
 * <tt>info-s=</tt> an alternate <tt>info</tt> font size in pixels (default=<tt>8</tt>)
 * <tt>wp-s=</tt> an alternate <tt>info</tt> emphasis font size in pixels (default=<tt>10</tt>, used for option 41 only)

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:
 * <tt> </tt>

produces the following userbox:

and declares your user page a member of: Template:User in England invokes this template to produce the same effect.
 * Category:Wikipedians in England
 * Category:Wikipedians in the United Kingdom