Template:Regbox/doc

P R O T O T Y P E  T E M P L A T E

This regional userbox template creates a customizable userbox on your user page. This template is normally invoked by other templates as a metatemplate, but it may also be used as a stand-alone template. The template syntax is:

 

where:
 * option= the option number (default=1)
 * region= the required region name as listed in Wikipedia
 * the= the text "the" if the word "the" normally precedes the region name (default=null)
 * adjective= the adjective form of the region name (default=region – required for options 41-43, optional for options 34-35, see below)
 * title=</tt> the fully formatted region title to be used in the userbox (default= | </tt>)
 * demonym=</tt> an optional regional demonym (only if preferred to the adjective for options 34-35, e.g., "This user is a Welshman" versus "This user is Welsh")
 * an=</tt> the text "an" if the optional regional demonym begins with a vowel sound (default=a)
 * nation=</tt> the nation name as listed in Wikipedia only if the region is a subdivision of a sovereign state (default=region</tt>)
 * nationality=</tt> the national adjective only if the region is a subdivision of a sovereign state (default=adjective</tt>)
 * project=</tt> the type of regional WikiProject (required for option 61):
 * project=WikiProject</tt> – a devoted regional WikiProject (default)
 * project=task force</tt> – a WikiProject regional task force
 * project=work group</tt> – a WikiProject regional work group
 * member=</tt> the type of regional project membership (required for option 61):
 * member=member</tt> (default)
 * member=participant</tt>
 * member=volunteer</tt>
 * <tt>main=</tt> the responsible regional WikiProject root name (default=<tt>region</tt> – required for option 61)
 * <tt>sub=</tt> the WikiProject regional task force or work group root name (default=<tt>region</tt> – required for option 61 if <tt>project=task force</tt> or <tt>project=work group</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>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=<tt>null</tt>, i.e., limited only by image height of 45 pixels)
 * <tt>info=</tt> an optional userbox text. The default userbox text is shown in the table below for each option number:

Override parameters
The following additional parameters may be used to override the normal userbox settings: See Template:Userbox for other default userbox settings.
 * <tt>border-c=</tt> an optional 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 optional horizontal alignment of the <tt>id</tt> (dafault=<tt>left</tt>)
 * <tt>id-c=</tt> an optional <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 optional width of the <tt>id</tt> in pixels (default=<tt>1</tt>)
 * <tt>info-c=</tt> an optional <tt>info</tt> background color (default=<tt>color</tt>)
 * <tt>info-fc=</tt> an optional <tt>info</tt> font color (default=<tt>black</tt>)
 * <tt>info-lh=</tt> an optional <tt>info</tt> line height (default=<tt> em </tt> for option 61, otherwise <tt>1.25em</tt>)
 * <tt>info-s=</tt> an optional <tt>info</tt> font size in pixels (default=<tt>8</tt>)
 * <tt>wp-s=</tt> an optional <tt>info</tt> emphasis font size in pixels (default=<tt>10</tt>, used for option 61 only)

Examples
Placing the following Wikitext on your user page:
 * <tt> </tt>

produces the following userbox:

The following userboxes demonstrate each of this template's options: